/contacts/ignore/{model_id}

Ignores a specific row based on the model_id in the url. These records will have their properties set to null, and will not be updated in future syncs. The “reason” and “message” fields in the request body will be stored for audit purposes.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

model_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

reasonenumRequired

GENERAL_CUSTOMER_REQUEST - GENERAL_CUSTOMER_REQUEST
GDPR - GDPR
OTHER - OTHER

* `GENERAL_CUSTOMER_REQUEST` - GENERAL_CUSTOMER_REQUEST * `GDPR` - GDPR * `OTHER` - OTHER

Allowed values:

messagestringOptional1-256 characters

Response

No response body

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.

1	import { MergeClient } from "@mergeapi/merge-node-client";
2
3	const client = new MergeClient({ apiKey: "YOUR_API_KEY", accountToken: "YOUR_ACCOUNT_TOKEN" });
4	await client.crm.contacts.ignoreCreate("model_id", {
5	reason: "GENERAL_CUSTOMER_REQUEST"
6	});

/contacts/ignore/{model_id}

Authentication

Path parameters

Headers

Request

Response

Field support by integration

Field support by integration