Skip to main content
PUT
/
v1
/
integrations
/
sync
/
engagements
Sync an engagement
curl --request PUT \
  --url https://functions.siro.ai/api-externalApi/v1/integrations/sync/engagements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalId": "<string>",
  "direction": "INBOUND",
  "content": "<string>",
  "subject": "<string>",
  "startTime": "<string>",
  "startTimeLocalized": "<string>",
  "endTime": "<string>",
  "remoteCreatedAt": "<string>",
  "remoteUpdatedAt": "<string>",
  "deletedAt": "2023-11-07T05:31:56Z",
  "engagementTypeId": "<string>",
  "engagementType": {
    "name": "<string>",
    "activityType": "MEETING",
    "externalId": "<string>"
  },
  "account": {
    "externalId": "<string>",
    "name": "<string>",
    "latitude": 123,
    "longitude": 123,
    "addresses": [
      {
        "country": "<string>",
        "street": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip": "<string>"
      }
    ],
    "phoneNumbers": [
      "<string>"
    ],
    "emailAddresses": [
      "<string>"
    ],
    "lastActivityAt": "<string>",
    "deletedAt": "2023-11-07T05:31:56Z",
    "owner": {
      "externalId": "<string>"
    },
    "mergedToExternalId": "<string>",
    "mergedFromExternalIds": [
      "<string>"
    ]
  },
  "engagementUsers": [
    {
      "externalId": "<string>",
      "email": "<string>",
      "shareOfSale": 123,
      "name": "<string>",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "opportunity": {
    "externalId": "<string>",
    "name": "<string>",
    "amount": 123,
    "closedAt": "<string>",
    "remoteCreatedAt": "<string>",
    "lastActivityAt": "<string>",
    "disposition": "OPEN",
    "copyEngagementRelationships": true
  },
  "lead": {
    "externalId": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "latitude": 123,
    "longitude": 123,
    "addresses": [
      {
        "country": "<string>",
        "street": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip": "<string>"
      }
    ],
    "phoneNumbers": [
      "<string>"
    ],
    "emailAddresses": [
      "<string>"
    ],
    "lastActivityAt": "<string>",
    "deletedAt": "2023-11-07T05:31:56Z",
    "owner": {
      "externalId": "<string>"
    },
    "mergedToExternalId": "<string>",
    "mergedFromExternalIds": [
      "<string>"
    ]
  },
  "contact": {
    "externalId": "<string>",
    "name": "<string>",
    "latitude": 123,
    "longitude": 123,
    "account": {
      "externalId": "<string>",
      "name": "<string>",
      "latitude": 123,
      "longitude": 123,
      "addresses": [
        {
          "country": "<string>",
          "street": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zip": "<string>"
        }
      ],
      "phoneNumbers": [
        "<string>"
      ],
      "emailAddresses": [
        "<string>"
      ],
      "lastActivityAt": "<string>",
      "deletedAt": "2023-11-07T05:31:56Z",
      "owner": {
        "externalId": "<string>"
      },
      "mergedToExternalId": "<string>",
      "mergedFromExternalIds": [
        "<string>"
      ]
    },
    "addresses": [
      {
        "country": "<string>",
        "street": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip": "<string>"
      }
    ],
    "phoneNumbers": [
      "<string>"
    ],
    "emailAddresses": [
      "<string>"
    ],
    "lastActivityAt": "<string>",
    "deletedAt": "2023-11-07T05:31:56Z",
    "owner": {
      "externalId": "<string>"
    },
    "mergedToExternalId": "<string>",
    "mergedFromExternalIds": [
      "<string>"
    ]
  }
}
'
{
  "data": {
    "id": "<string>",
    "externalId": "<string>",
    "engagementType": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "organizationId": "<string>",
    "direction": "<string>",
    "subject": "<string>",
    "content": "<string>",
    "startTime": "<string>",
    "startTimeLocalized": "<string>",
    "endTime": "<string>",
    "recordingId": "<string>",
    "opportunityId": "<string>",
    "accountId": "<string>",
    "account": null,
    "engagementUsers": [
      null
    ]
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
externalId
string
required

The ID of the engagement in the external system

​
direction
enum<string> | null

The direction of the engagement (INBOUND/OUTBOUND)

Available options:
INBOUND,
OUTBOUND
​
content
string | null

The content of the engagement

​
subject
string | null

The subject of the engagement

​
startTime
string | null

start dateTime of the engagement in UTC.

​
startTimeLocalized
string | null

Localized dateTime of the engagement, without timezone info. When present, the frontend will display this as-is without timezone conversion, overriding startTime for display purposes.

​
endTime
string | null

end dateTime of the engagement

​
remoteCreatedAt
string | null

external engagement creation datetime

​
remoteUpdatedAt
string | null

external engagement update datetime

​
deletedAt
string<date-time> | null

The datetime when this record was deleted in the external system

​
engagementTypeId
string | null

Internal SIRO engagementTypeId override for this engagement. OPTIONAL -- only use if you know the internal value of the engagement type as it will override the engagementType object args.

​
engagementType
object

The type of this engagement

​
account
object

The associated account for this engagement. Note: supplying just an externalId will resolve to an already-synced account

​
engagementUsers
object[]

The users associated with this engagement

​
opportunity
object

The associated opportunity for this engagement. Note: supplying just an externalId will resolve to an already-synced opportunity

​
lead
object

The associated lead for this engagement

​
contact
object

The associated contact for this engagement. Note: supplying just an externalId will resolve to an already-synced contact

Response

200 - application/json

Sync an engagement

​
data
object
required