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 1 of the 49 revisions of this API.55
- ▲
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
- ▲