engagements create
POST {{baseUrl}}/engagements
Creates an Engagement object with the given values.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
is_debug_mode | boolean | Whether to include debug fields (such as log file links) in the response. | |
run_async | boolean | Whether or not third-party updates should be run asynchronously. |
Request Body
[{"name"=>"remote_id", "value"=>"19202938", "datatype"=>"number"}, {"name"=>"owner", "value"=>"0358cbc6-2040-430a-848e-aafacbadf3aa", "datatype"=>"string"}, {"name"=>"content", "value"=>"Call for negotiation", "datatype"=>"string"}, {"name"=>"subject", "value"=>"Call from customer", "datatype"=>"string"}, {"name"=>"direction", "value"=>"OUTBOUND", "datatype"=>"string"}, {"name"=>"engagement_type", "value"=>"0358cbc6-2040-430a-848e-aafacbadf3aa", "datatype"=>"string"}, {"name"=>"start_time", "value"=>"2022-02-10T00:00:00Z", "datatype"=>"string"}, {"name"=>"end_time", "value"=>"2022-02-10T00:05:00Z", "datatype"=>"string"}, {"name"=>"account", "value"=>"urn:uuid:2e8555d8-30c1-733a-efeb-9aeea1816bb4", "datatype"=>"string"}, {"name"=>"integration_params", "value"=>"{\"elit0a\":{},\"sint1cf\":{}}", "datatype"=>"string"}, {"name"=>"linked_account_params", "value"=>"{\"occaecat22\":{},\"in_28\":{},\"ut_0ac\":{},\"magna_\":{}}", "datatype"=>"string"}]
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Account-Token | string | (Required) Token identifying the end user. | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"errors":[{"detail":"custom_fields is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","title":"Missing Required Field","source":{"pointer":"irure voluptate"}},{"detail":"custom_fields is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","title":"Missing Required Field","source":{"pointer":"ad non"}}],"model":{"id":"15c36c89-e130-2c20-7855-101be1e0f942","remote_id":"19202938","owner":"0358cbc6-2040-430a-848e-aafacbadf3aa","content":"Call for negotiation","subject":"Call from customer","direction":"OUTBOUND","engagement_type":"0358cbc6-2040-430a-848e-aafacbadf3aa","start_time":"2022-02-10T00:00:00Z","end_time":"2022-02-10T00:05:00Z","account":"45170daf-0841-b065-1d47-3147433ba5c7","remote_data":[{"path":"et pariatur","data":{"laborefd6":{},"minim_c":{}}},{"path":"dolor proident","data":{"aliqua_a9":{}}}],"remote_was_deleted":false},"warnings":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","title":"Unrecognized Field","source":{"pointer":"est laborum nostrud dolor"}},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","title":"Unrecognized Field","source":{"pointer":"d"}}],"logs":[{"dashboard_view":"https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832","log_id":"99433219-8017-4acd-bb3c-ceb23d663832","log_summary":{"method":"POST","status_code":200,"url":"https://harvest.greenhouse.io/v1/candidates/"}},{"dashboard_view":"https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832","log_id":"99433219-8017-4acd-bb3c-ceb23d663832","log_summary":{"method":"POST","status_code":200,"url":"https://harvest.greenhouse.io/v1/candidates/"}}]}