Skip to main content
PUT
/
events
Synchronize Events and Invitations
curl --request PUT \
  --url https://app.essentry.com/api/v2/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "agentToken": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "events": [
    {
      "sourceId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "startsAt": "2023-11-07T05:31:56Z",
      "endsAt": "2023-11-07T05:31:56Z",
      "locationId": 123,
      "entranceId": 123,
      "host": {
        "email": "jsmith@example.com",
        "firstName": "<string>",
        "lastName": "<string>",
        "phoneNumber": "<string>"
      },
      "creator": {
        "email": "jsmith@example.com",
        "firstName": "<string>",
        "lastName": "<string>",
        "phoneNumber": "<string>"
      },
      "invitations": [
        {
          "sourceId": "<string>",
          "email": "jsmith@example.com",
          "firstName": "<string>",
          "lastName": "<string>",
          "companyName": "<string>",
          "customFields": {},
          "language": "CS",
          "accessProfiles": [
            {
              "partitionId": 123,
              "sourceId": "<string>"
            }
          ]
        }
      ],
      "customFields": {},
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ]
}'
{
  "events": [
    {
      "sourceId": "<string>",
      "status": "SUCCESS"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

ignoreMissingInvitations
boolean
default:false

Body

application/json
agentToken
string<uuid>
required

This is the ID of the integration. If you're unsure what to enter here, please ask the essentry team.

events
object[]
required
Minimum length: 1

Response

200 - application/json

The request has succeeded.

events
object[]
required