curl --request PUT \
--url https://api.example.com/v1/integrations/sync/engagements \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"externalId": "<string>",
"direction": "INBOUND",
"content": "<string>",
"subject": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"remoteCreatedAt": "<string>",
"remoteUpdatedAt": "<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>"
},
"engagementUsers": [
{
"externalId": "<string>",
"email": "<string>",
"shareOfSale": 123,
"name": "<string>"
}
],
"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>"
},
"contact": {
"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>"
}
}
'{
"data": {
"id": "<string>",
"externalId": "<string>",
"engagementType": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"organizationId": "<string>",
"direction": "<string>",
"subject": "<string>",
"content": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"recordingId": "<string>",
"opportunityId": "<string>",
"accountId": "<string>",
"account": "<unknown>",
"engagementUsers": [
"<unknown>"
]
}
}Sync an engagement
curl --request PUT \
--url https://api.example.com/v1/integrations/sync/engagements \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"externalId": "<string>",
"direction": "INBOUND",
"content": "<string>",
"subject": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"remoteCreatedAt": "<string>",
"remoteUpdatedAt": "<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>"
},
"engagementUsers": [
{
"externalId": "<string>",
"email": "<string>",
"shareOfSale": 123,
"name": "<string>"
}
],
"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>"
},
"contact": {
"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>"
}
}
'{
"data": {
"id": "<string>",
"externalId": "<string>",
"engagementType": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"organizationId": "<string>",
"direction": "<string>",
"subject": "<string>",
"content": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"recordingId": "<string>",
"opportunityId": "<string>",
"accountId": "<string>",
"account": "<unknown>",
"engagementUsers": [
"<unknown>"
]
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
INBOUND, OUTBOUND Show child attributes
Show child attributes
Show child attributes
Show child attributes
Sync an engagement
Show child attributes
The ID of the engagement in the external system (e.g. Salesforce)
The type of the engagement
The date the engagement was created
The date the engagement was last updated
"INBOUND" | "OUTBOUND"
The subject of the engagement
The content of the engagement
The start time of the engagement
The end time of the engagement
The ID of the recording associated to the engagement
The ID of the opportunity associated to the engagement