Home
API Reference

Update Unit Event Recipient Configuration (BETA)

patch
https://resources.uk.eagleeye.com/units//events/recipients/

This method allows the calling application to update the configuration of a Unit Event Recipient. Please note that the unitId must be that of the calling unit.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

EES AIR Unit ID.

string
required

The unique identifier of the Unit Event Recipient.

Body Params

Payload to update Unit Event Recipient Configuration. There are no required fields but the payload must not be empty. However if the new recipient configuration has missing required properties not already set, these will be reported back as required with an error.

string
enum

The type of recipient.

Allowed:
recipientDetails
object
boolean

Flag indicating whether the recipient is enabled.

Headers
string
required

Client ID, This will be provided by EES and is unique to the company calling the API.

string
required

Request Security Hash, calculated using SHA-256 function from concatenated full Request URI Path with Query String(s), Payload and Client Secret.

string
enum

This request HTTP header advertises which content encoding (usually a compression algorithm) the calling application is able to understand. The server selects one of the proposals, use it and informs the client of its choice with the Content-Encoding response header. Currently supported gzip and deflate, if request header not present no compression will be used.

Allowed:
string

Unique Reference for the API transaction within the calling company.

Responses

Updated 3 months ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 3 months ago

Did this page help you?