/contacts

import { MergeClient } from "@mergeapi/merge-node-client";
const client = new MergeClient({ apiKey: "YOUR_API_KEY", accountToken: "YOUR_ACCOUNT_TOKEN" });
await client.crm.contacts.create({
    isDebugMode: true,
    runAsync: true,
    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",
    "first_name": "Gil",
    "last_name": "Feig",
    "account": "0958cbc6-6040-430a-848e-aafacbadf4ae",
    "owner": "b8fbfc30-0982-420e-8c20-dab07b70b9d6",
    "addresses": [
      {
        "created_at": "2021-09-15T00:00:00Z",
        "modified_at": "2021-10-16T00:00:00Z",
        "street_1": "50 Bowling Green Dr",
        "street_2": "Golden Gate Park",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94122",
        "country": "US",
        "address_type": "BILLING"
      }
    ],
    "email_addresses": [
      {
        "email_address": "hello@merge.dev",
        "email_address_type": "Work"
      }
    ],
    "phone_numbers": [
      {
        "created_at": "2021-09-15T00:00:00Z",
        "modified_at": "2021-10-16T00:00:00Z",
        "phone_number": "+13785579223",
        "phone_number_type": "Mobile"
      }
    ],
    "last_activity_at": "2022-02-10T00:00:00Z",
    "remote_created_at": "2021-11-10T00:00:00Z",
    "remote_was_deleted": true,
    "field_mappings": {
      "organization_defined_targets": {
        "custom_key": "custom_value"
      },
      "linked_account_defined_targets": {
        "custom_key": "custom_value"
      }
    },
    "remote_data": [
      {
        "path": "/contacts"
      }
    ],
    "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 a Contact 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 Contact object is used to represent an existing point of contact at a company in a CRM system.

Usage Example

TODO

Response

modelobject

Description

The Contact object is used to represent an existing point of contact at a company in a CRM system.

Usage Example

TODO

warningslist of objects

errorslist of objects

logslist of objects or null

Supported POST model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

ownerstring or nullOptionalformat: "uuid"

The contact's owner.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

last_activity_atdatetime or nullOptional

When the contact's last activity occurred.

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_fieldslist of objectsOptionalRead-only

Supported POST model parameters

first_namestring or nullRequired

The contact's first name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

last_activity_atdatetime or nullOptional

When the contact's last activity occurred.

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_fieldslist of objectsOptionalRead-only

Supported POST model parameters

last_namestring or nullRequired

The contact's last name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

last_activity_atdatetime or nullOptional

When the contact's last activity occurred.

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_fieldslist of objectsOptionalRead-only

Supported POST model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

last_activity_atdatetime or nullOptional

When the contact's last activity occurred.

remote_created_atdatetime or nullOptional

When the third party's contact was created.

Supported POST model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

ownerstring or nullOptionalformat: "uuid"

The contact's owner.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

last_activity_atdatetime or nullOptional

When the contact's last activity occurred.

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_fieldslist of objectsOptionalRead-only

Supported POST model parameters

first_namestring or nullRequired

The contact's first name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

last_activity_atdatetime or nullOptional

When the contact's last activity occurred.

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_fieldslist of objectsOptionalRead-only

Supported POST model parameters

last_namestring or nullRequired

The contact's last name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

addresseslist of objectsOptional

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

last_activity_atdatetime or nullOptional

When the contact's last activity occurred.

remote_created_atdatetime or nullOptional

When the third party's contact was created.

remote_fieldslist of objectsOptionalRead-only

Supported POST model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The contact's first name.

last_namestring or nullOptional

The contact's last name.

accountstring or nullOptionalformat: "uuid"

The contact's account.

email_addresseslist of objectsOptional

phone_numberslist of objectsOptional

last_activity_atdatetime or nullOptional

When the contact's last activity occurred.

remote_created_atdatetime or nullOptional

When the third party's contact was created.

Authentication

Headers

Query parameters

Request

Description

Usage Example

Response

Description

Usage Example

Field support by integration

Field support by integration