Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Units

Update Unit Event Recipient Configuration (BETA)

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.

patch/units/{unitId}/events/recipients/{recipientId}

Path parameters

unitIdstring Int64 required

EES AIR Unit ID.

recipientIdstring Int64 required

The unique identifier of the Unit Event Recipient.

Headers

X-EES-AUTH-CLIENT-IDstring string required

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

X-EES-AUTH-HASHstring string required

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

Accept-Encoding'' | 'gzip' | 'deflate' | 'gzip,deflate'

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.

X-EES-TRANSACTION-IDstring string

Unique Reference for the API transaction within the calling company.

Request body

OR
OR

Response

Successful Response with Unit Event Recipient Configuration Payload.

OR
OR

Example response

{
  "id": "123",
  "type": "AUTHENTICATED_REQUEST",
  "recipientDetails": {
    "url": "https://example.com/unit-events",
    "requestMethod": "POST",
    "authenticationType": "oauth2",
    "expectedHttpCodes": [
      200,
      201,
      204
    ],
    "headers": {
      "Content-Type": "application/json",
      "Accept": "*/*"
    },
    "authentication": {
      "grantType": "client_credentials",
      "endpoint": "https://example.com/oauth2/token",
      "scope": "openid"
    }
  },
  "enabled": true
}