Create Engagements
Create Engagements in any supported Crm software
Query parameters
Set to true to include data from the original Crm software.
Headers
The connection token
Request body
Example request
{
"content": "Meeting call with CTO",
"direction": "INBOUND",
"subject": "Technical features planning",
"start_at": "2024-10-01T12:00:00Z",
"end_time": "2024-10-01T22:00:00Z",
"type": "MEETING",
"user_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
"company_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
"contacts": [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
],
"field_mappings": {
"fav_dish": "broccoli",
"fav_color": "red"
}
}Response
Example response
{
"content": "Meeting call with CTO",
"direction": "INBOUND",
"subject": "Technical features planning",
"start_at": "2024-10-01T12:00:00Z",
"end_time": "2024-10-01T22:00:00Z",
"type": "MEETING",
"user_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
"company_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
"contacts": [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
],
"field_mappings": {
"fav_dish": "broccoli",
"fav_color": "red"
},
"id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
"remote_id": "id_1",
"remote_data": {
"fav_dish": "broccoli",
"fav_color": "red"
},
"created_at": "2024-10-01T12:00:00Z",
"modified_at": "2024-10-01T12:00:00Z"
}Changes
Changed in 6 of the 18 revisions of this API.62539
- ▲
removed the enum value
CALLof the request propertytyperequest-property-enum-value-removed
- ▲
removed the enum value
EMAILof the request propertytyperequest-property-enum-value-removed
- ▲
removed the enum value
INBOUNDof the request propertydirectionrequest-property-enum-value-removed
- ▲
removed the enum value
MEETINGof the request propertytyperequest-property-enum-value-removed
- ▲
removed the enum value
OUTBOUNDof the request propertydirectionrequest-property-enum-value-removed
- ○
removed the
CALLenum value from thetyperesponse property for the response status201response-property-enum-value-removed
- ○
removed the
EMAILenum value from thetyperesponse property for the response status201response-property-enum-value-removed
- ○
removed the
INBOUNDenum value from thedirectionresponse property for the response status201response-property-enum-value-removed
- ○
removed the
MEETINGenum value from thetyperesponse property for the response status201response-property-enum-value-removed
- ○
removed the
OUTBOUNDenum value from thedirectionresponse property for the response status201response-property-enum-value-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ▲
request property
directionwas restricted to a list of enum valuesrequest-property-became-enum
- ▲
request property
typewas restricted to a list of enum valuesrequest-property-became-enum
- ●
added the new
CALLenum value to thetyperesponse property for the response status201response-property-enum-value-added
- ●
added the new
EMAILenum value to thetyperesponse property for the response status201response-property-enum-value-added
- ●
added the new
INBOUNDenum value to thedirectionresponse property for the response status201response-property-enum-value-added
- ●
added the new
MEETINGenum value to thetyperesponse property for the response status201response-property-enum-value-added
- ●
added the new
OUTBOUNDenum value to thedirectionresponse property for the response status201response-property-enum-value-added
- ○
added the new
CALLenum value to the request propertytyperequest-property-enum-value-added
- ○
added the new
EMAILenum value to the request propertytyperequest-property-enum-value-added
- ○
added the new
INBOUNDenum value to the request propertydirectionrequest-property-enum-value-added
- ○
added the new
MEETINGenum value to the request propertytyperequest-property-enum-value-added
- ○
added the new
OUTBOUNDenum value to the request propertydirectionrequest-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ▲
the response property
company_idbecame nullable for the status201response-property-became-nullable
- ▲
the response property
contactsbecame nullable for the status201response-property-became-nullable
- ▲
the response property
contentbecame nullable for the status201response-property-became-nullable
- ▲
the response property
created_atbecame nullable for the status201response-property-became-nullable
- ▲
the response property
directionbecame nullable for the status201response-property-became-nullable
- ▲
the response property
end_timebecame nullable for the status201response-property-became-nullable
- ▲
the response property
field_mappingsbecame nullable for the status201response-property-became-nullable
- ▲
the response property
idbecame nullable for the status201response-property-became-nullable
- ▲
the response property
modified_atbecame nullable for the status201response-property-became-nullable
- ▲
the response property
remote_databecame nullable for the status201response-property-became-nullable
- ▲
the response property
remote_idbecame nullable for the status201response-property-became-nullable
- ▲
the response property
start_atbecame nullable for the status201response-property-became-nullable
- ▲
the response property
subjectbecame nullable for the status201response-property-became-nullable
- ▲
the response property
typebecame nullable for the status201response-property-became-nullable
- ▲
the response property
user_idbecame nullable for the status201response-property-became-nullable
- ▲
the response property
created_atbecame optional for the status201response-property-became-optional
- ▲
the response property
field_mappingsbecame optional for the status201response-property-became-optional
- ▲
the response property
modified_atbecame optional for the status201response-property-became-optional
- ▲
the response property
remote_databecame optional for the status201response-property-became-optional
- ▲
the
created_atresponse's property type/format changed fromobject/tostring/date-timefor status201response-property-type-changed
- ▲
the
modified_atresponse's property type/format changed fromobject/tostring/date-timefor status201response-property-type-changed
- ○
the endpoint scheme security
bearerwas removed from the APIapi-security-removed
- ○
the request property
company_idbecame nullablerequest-property-became-nullable
- ○
the request property
contactsbecame nullablerequest-property-became-nullable
- ○
the request property
contentbecame nullablerequest-property-became-nullable
- ○
the request property
directionbecame nullablerequest-property-became-nullable
- ○
the request property
end_timebecame nullablerequest-property-became-nullable
- ○
the request property
field_mappingsbecame nullablerequest-property-became-nullable
- ○
the request property
start_atbecame nullablerequest-property-became-nullable
- ○
the request property
subjectbecame nullablerequest-property-became-nullable
- ○
the request property
typebecame nullablerequest-property-became-nullable
- ○
the request property
user_idbecame nullablerequest-property-became-nullable
- ○
the request property
field_mappingsbecame optionalrequest-property-became-optional
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ▲
the request property
company_idbecame not nullablerequest-property-became-not-nullable
- ▲
the request property
contactsbecame not nullablerequest-property-became-not-nullable
- ▲
the request property
contentbecame not nullablerequest-property-became-not-nullable
- ▲
the request property
directionbecame not nullablerequest-property-became-not-nullable
- ▲
the request property
end_timebecame not nullablerequest-property-became-not-nullable
- ▲
the request property
field_mappingsbecame not nullablerequest-property-became-not-nullable
- ▲
the request property
start_atbecame not nullablerequest-property-became-not-nullable
- ▲
the request property
subjectbecame not nullablerequest-property-became-not-nullable
- ▲
the request property
typebecame not nullablerequest-property-became-not-nullable
- ▲
the request property
user_idbecame not nullablerequest-property-became-not-nullable
- ▲
the request property
field_mappingsbecame requiredrequest-property-became-required
- ▲
the
created_atresponse's property type/format changed fromstring/date-timetoobject/for status201response-property-type-changed
- ▲
the
modified_atresponse's property type/format changed fromstring/date-timetoobject/for status201response-property-type-changed
- ○
the endpoint scheme security
bearerwas added to the APIapi-security-added
- ○
the response property
created_atbecame required for the status201response-property-became-required
- ○
the response property
field_mappingsbecame required for the status201response-property-became-required
- ○
the response property
modified_atbecame required for the status201response-property-became-required
- ○
the response property
remote_databecame required for the status201response-property-became-required
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ▲
the response property
company_idbecame nullable for the status201response-property-became-nullable
- ▲
the response property
contactsbecame nullable for the status201response-property-became-nullable
- ▲
the response property
contentbecame nullable for the status201response-property-became-nullable
- ▲
the response property
created_atbecame nullable for the status201response-property-became-nullable
- ▲
the response property
directionbecame nullable for the status201response-property-became-nullable
- ▲
the response property
end_timebecame nullable for the status201response-property-became-nullable
- ▲
the response property
field_mappingsbecame nullable for the status201response-property-became-nullable
- ▲
the response property
idbecame nullable for the status201response-property-became-nullable
- ▲
the response property
modified_atbecame nullable for the status201response-property-became-nullable
- ▲
the response property
remote_databecame nullable for the status201response-property-became-nullable
- ▲
the response property
remote_idbecame nullable for the status201response-property-became-nullable
- ▲
the response property
start_atbecame nullable for the status201response-property-became-nullable
- ▲
the response property
subjectbecame nullable for the status201response-property-became-nullable
- ▲
the response property
typebecame nullable for the status201response-property-became-nullable
- ▲
the response property
user_idbecame nullable for the status201response-property-became-nullable
- ▲
the response property
created_atbecame optional for the status201response-property-became-optional
- ▲
the response property
field_mappingsbecame optional for the status201response-property-became-optional
- ▲
the response property
modified_atbecame optional for the status201response-property-became-optional
- ▲
the response property
remote_databecame optional for the status201response-property-became-optional
- ▲
the
created_atresponse's property type/format changed fromobject/tostring/date-timefor status201response-property-type-changed
- ▲
the
modified_atresponse's property type/format changed fromobject/tostring/date-timefor status201response-property-type-changed
- ○
the request property
company_idbecame nullablerequest-property-became-nullable
- ○
the request property
contactsbecame nullablerequest-property-became-nullable
- ○
the request property
contentbecame nullablerequest-property-became-nullable
- ○
the request property
directionbecame nullablerequest-property-became-nullable
- ○
the request property
end_timebecame nullablerequest-property-became-nullable
- ○
the request property
field_mappingsbecame nullablerequest-property-became-nullable
- ○
the request property
start_atbecame nullablerequest-property-became-nullable
- ○
the request property
subjectbecame nullablerequest-property-became-nullable
- ○
the request property
typebecame nullablerequest-property-became-nullable
- ○
the request property
user_idbecame nullablerequest-property-became-nullable
- ○
the request property
field_mappingsbecame optionalrequest-property-became-optional
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ○
the endpoint scheme security
bearerwas removed from the APIapi-security-removed
- ○