/engagements

curl -X POST https://api.merge.dev/api/crm/v1/engagements \
     -H "X-Account-Token: X-Account-Token" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "model": {}
}'

{
  "model": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "remote_id": "19202938",
    "created_at": "2021-09-15T00:00:00Z",
    "modified_at": "2021-10-16T00:00:00Z",
    "owner": "0358cbc6-2040-430a-848e-aafacbadf3aa",
    "content": "Call for negotiation",
    "subject": "Call from customer",
    "direction": "INBOUND",
    "engagement_type": "0358cbc6-2040-430a-848e-aafacbadf3aa",
    "start_time": "2022-02-10T00:00:00Z",
    "end_time": "2022-02-10T00:05:00Z",
    "account": "025fjlc6-6000-430a-848e-aafacbadf4fe",
    "contacts": [
      "a7c55bc6-2940-c80a-848e-bbfacbfdf4fg"
    ],
    "remote_was_deleted": true,
    "field_mappings": {
      "organization_defined_targets": {
        "custom_key": "custom_value"
      },
      "linked_account_defined_targets": {
        "custom_key": "custom_value"
      }
    },
    "remote_data": [
      {
        "path": "/engagements"
      }
    ],
    "remote_fields": [
      {
        "remote_field_class": {
          "id": "string",
          "display_name": "string",
          "remote_key_name": "string",
          "description": "string",
          "is_custom": true,
          "is_common_model_field": true,
          "is_required": true,
          "field_type": "string",
          "field_format": "string",
          "field_choices": [
            "string"
          ],
          "item_schema": {
            "item_type": "string",
            "item_format": "string",
            "item_choices": [
              "string"
            ]
          }
        },
        "value": "string"
      }
    ]
  },
  "warnings": [
    {
      "title": "Unrecognized Field",
      "detail": "An unrecognized field, age, was passed in with request data.",
      "problem_type": "UNRECOGNIZED_FIELD",
      "source": {
        "pointer": "/age"
      },
      "block_merge_link": true
    }
  ],
  "errors": [
    {
      "title": "Missing Required Field",
      "detail": "custom_fields is a required field on model.",
      "problem_type": "MISSING_REQUIRED_FIELD",
      "source": {
        "pointer": "/model/custom_fields"
      },
      "block_merge_link": true
    }
  ],
  "logs": [
    {
      "log_id": "99433219-8017-4acd-bb3c-ceb23d663832",
      "dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832",
      "log_summary": {
        "url": "www.exampleintegration.com/api/v1/exampleapi",
        "method": "POST",
        "status_code": 200
      }
    }
  ]
}

Creates an Engagement object with the given values.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

is_debug_modebooleanOptional

Whether to include debug fields (such as log file links) in the response.

run_asyncbooleanOptional

Whether or not third-party updates should be run asynchronously.

Request

This endpoint expects an object.

modelobjectRequired

Description

The Engagement object is used to represent an interaction noted in a CRM system.

Usage Example

TODO

Response

modelobject

Description

The Engagement object is used to represent an interaction noted in a CRM system.

Usage Example

TODO

warningslist of objects

errorslist of objects

logslist of objects or null

Supported POST model parameters

engagement_typestring or nullRequiredformat: "uuid"

The engagement type of the engagement.

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

directionenum or nullOptional

The engagement’s direction.

INBOUND - INBOUND
OUTBOUND - OUTBOUND

Allowed values:

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

contactslist of stringsOptional

Supported POST model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

Supported POST model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

directionenum or nullOptional

The engagement’s direction.

INBOUND - INBOUND
OUTBOUND - OUTBOUND

Allowed values:

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

Supported POST model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

directionenum or nullOptional

The engagement’s direction.

INBOUND - INBOUND
OUTBOUND - OUTBOUND

Allowed values:

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

Supported POST model parameters

engagement_typestring or nullRequiredformat: "uuid"

The engagement type of the engagement.

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

directionenum or nullOptional

The engagement’s direction.

INBOUND - INBOUND
OUTBOUND - OUTBOUND

Allowed values:

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

contactslist of stringsOptional

Supported POST model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

Supported POST model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

directionenum or nullOptional

The engagement’s direction.

INBOUND - INBOUND
OUTBOUND - OUTBOUND

Allowed values:

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

Supported POST model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

directionenum or nullOptional

The engagement’s direction.

INBOUND - INBOUND
OUTBOUND - OUTBOUND

Allowed values:

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

/engagements

Authentication

Headers

Query parameters

Request

Description

Usage Example

Response

Description

Usage Example

Field support by integration

Field support by integration