Contacts | Docs

Contact Lists: Create

Creates a static list or a rule-based Smart List for a Knowledge Graph Entity.

Send the list fields directly, without a contactList wrapper. The default kind is CONTACT_LIST_KIND_STATIC. Add contacts to a static list using Contact List Memberships: Create.

For a Smart List, set kind to CONTACT_LIST_KIND_DYNAMIC and provide dynamicRule. Any custom fields referenced by the rule must already be defined. Save the returned ruleRevision and condition IDs for future rule updates.

Static lists can include an externalIdentity to synchronize with another system. Reusing the same source identity updates the matching list and can restore a deleted match. Smart Lists do not accept an external identity.

Authorizations:

NoneNone

path Parameters

account

required

string

External account ID, or me for the credential's own account.

query Parameters

v

required

string^[0-9]{8}$

Default: "20240401"

API version date in YYYYMMDD format. Use one fixed date for your integration; supply this parameter once per request.

Request Body schema: application/json

displayName	string List display name; send the intended full name on metadata updates.
description	string Optional list description; blank or omitted on update clears it.
entityId	string Required external Entity ID string on create/update. The list belongs to that entity.
	contactsContactListKind (string) or (object or null) CONTACT_LIST_KIND_STATIC contains explicitly added contacts; CONTACT_LIST_KIND_DYNAMIC selects contacts using a Smart List rule. Defaults to STATIC on create. Cannot be changed after creation.
	contactsContactListRule (object) or (object or null) Rule used to select Smart List contacts. Required when creating a Smart List. Omit to keep the current rule during an update. Replacing the rule requires expectedRuleRevision in the query.
	contactsExternalIdentity (object) or (object or null) List identity in another system. Supported only when creating or synchronizing static lists. Cannot be changed through an update.

Responses

Request samples

Payload

Content type

application/json

{"displayName": "New York newsletter subscribers",
"description": "CRM-managed static audience for the New York branch.",
"entityId": "branch-nyc-001",
"kind": "CONTACT_LIST_KIND_STATIC",
"externalIdentity": {"source": "salesforce",
"externalId": "campaign-newsletter-nyc"
}
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "7b4b7f0f-17cf-4bec-81b0-97a729f25e54",
"errors": [ ]
},
"response": {"displayName": "New York newsletter subscribers",
"description": "CRM-managed static audience for the New York branch.",
"entityId": "branch-nyc-001",
"kind": "CONTACT_LIST_KIND_STATIC",
"externalIdentity": {"source": "salesforce",
"externalId": "campaign-newsletter-nyc"
},
"name": "accounts/514581/contactLists/019a1234-5678-7000-8000-000000000002",
"uid": "019a1234-5678-7000-8000-000000000002",
"businessId": "514581",
"entityLabel": "New York Main Branch",
"ruleRevision": "0",
"createdAt": "2026-10-26T15:30:00Z",
"updatedAt": "2026-10-26T15:30:00Z",
"deletedAt": null,
"dynamicRule": null
}
}

Contact Lists: List

Returns static lists and Smart Lists you have permission to access.

Use query to search by list name and Entity filters to narrow the results. The response contains list details rather than the contacts in each list.

Pass the returned nextPageToken as pageToken with the same filters to continue.

Authorizations:

NoneNone

path Parameters

account

required

string

External account ID, or me for the credential's own account.

query Parameters

query	string Search text used to narrow the results. Recent changes may take time to appear in search results.
pageSize	integer <int32> Requested page size. Nonpositive values use 50; above 1000 is capped.
pageToken	string Token returned in nextPageToken by the previous response. Keep the other search parameters unchanged. Omit for the first page.
entityId	string Exact external Entity ID string; takes precedence over a broader selected entity scope.
selectedEntityScope.entityIds	Array of strings Knowledge Graph external entity IDs for this account.
selectedEntityScope.folderIds	Array of strings <int64>
selectedEntityScope.labelIds	Array of strings <int64>
ids	Array of strings Restrict results to these Yext-assigned UUIDs. Repeat ids once per UUID.
v required	string^[0-9]{8}$ Default: "20240401" API version date in YYYYMMDD format. Use one fixed date for your integration; supply this parameter once per request.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "7b4b7f0f-17cf-4bec-81b0-97a729f25e54",
"errors": [ ]
},
"response": {"contactLists": [{"displayName": "New York newsletter subscribers",
"description": "CRM-managed static audience for the New York branch.",
"entityId": "branch-nyc-001",
"kind": "CONTACT_LIST_KIND_STATIC",
"externalIdentity": {"source": "salesforce",
"externalId": "campaign-newsletter-nyc"
},
"name": "accounts/514581/contactLists/019a1234-5678-7000-8000-000000000002",
"uid": "019a1234-5678-7000-8000-000000000002",
"businessId": "514581",
"entityLabel": "New York Main Branch",
"ruleRevision": "0",
"createdAt": "2026-10-26T15:30:00Z",
"updatedAt": "2026-10-26T15:30:00Z",
"deletedAt": null,
"dynamicRule": null
},
{"displayName": "Gold customers",
"description": "Customers whose tier is gold.",
"entityId": "branch-nyc-001",
"kind": "CONTACT_LIST_KIND_DYNAMIC",
"dynamicRule": {"version": 1,
"matchMode": "CONTACT_LIST_RULE_MATCH_MODE_ALL",
"conditions": [{"customFieldKey": "customer_tier",
"operator": "CONTACT_LIST_RULE_OPERATOR_EQUALS",
"value": {"stringValue": "gold"
},
"id": "019a1234-5678-7000-8000-000000000006"
}
]
},
"name": "accounts/514581/contactLists/019a1234-5678-7000-8000-000000000002",
"uid": "019a1234-5678-7000-8000-000000000002",
"businessId": "514581",
"entityLabel": "New York Main Branch",
"ruleRevision": "1",
"createdAt": "2026-10-26T15:30:00Z",
"updatedAt": "2026-10-26T15:30:00Z",
"deletedAt": null,
"externalIdentity": null
}
],
"nextPageToken": ""
}
}

Contact Lists: Update

Updates a list's name, description, or Smart List rule within its existing Entity.

Provide entityId and the complete displayName and description you want to keep. The list's kind and external identity cannot be changed. Omit kind or send its existing value.

Omit dynamicRule to keep the current rule. To replace a Smart List rule, first retrieve the list, preserve the IDs of existing conditions, and set the expectedRuleRevision query parameter to the returned ruleRevision. This revision belongs in the query, not the request body.

A missing revision is invalid when replacing a rule. A stale revision returns a conflict. Static lists cannot be converted to Smart Lists.

Authorizations:

NoneNone

path Parameters

account required	string External account ID, or `me` for the credential's own account.
contactList required	string Yext-assigned resource UUID.

query Parameters

expectedRuleRevision	string <uint64>
v required	string^[0-9]{8}$ Default: "20240401" API version date in YYYYMMDD format. Use one fixed date for your integration; supply this parameter once per request.

Request Body schema: application/json

displayName	string List display name; send the intended full name on metadata updates.
description	string Optional list description; blank or omitted on update clears it.
entityId	string Required external Entity ID string on create/update. The list belongs to that entity.
	contactsContactListKind (string) or (object or null) CONTACT_LIST_KIND_STATIC contains explicitly added contacts; CONTACT_LIST_KIND_DYNAMIC selects contacts using a Smart List rule. Defaults to STATIC on create. Cannot be changed after creation.
	contactsContactListRule (object) or (object or null) Rule used to select Smart List contacts. Required when creating a Smart List. Omit to keep the current rule during an update. Replacing the rule requires expectedRuleRevision in the query.
	contactsExternalIdentity (object) or (object or null) List identity in another system. Supported only when creating or synchronizing static lists. Cannot be changed through an update.

Responses

Request samples

Payload

Content type

application/json

{"displayName": "New York newsletter subscribers",
"description": "Updated newsletter audience description.",
"entityId": "branch-nyc-001",
"kind": "CONTACT_LIST_KIND_STATIC"
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "7b4b7f0f-17cf-4bec-81b0-97a729f25e54",
"errors": [ ]
},
"response": {"displayName": "New York newsletter subscribers",
"description": "Updated newsletter audience description.",
"entityId": "branch-nyc-001",
"kind": "CONTACT_LIST_KIND_STATIC",
"externalIdentity": {"source": "salesforce",
"externalId": "campaign-newsletter-nyc"
},
"name": "accounts/514581/contactLists/019a1234-5678-7000-8000-000000000002",
"uid": "019a1234-5678-7000-8000-000000000002",
"businessId": "514581",
"entityLabel": "New York Main Branch",
"ruleRevision": "0",
"createdAt": "2026-10-26T15:30:00Z",
"updatedAt": "2026-10-26T15:30:00Z",
"deletedAt": null,
"dynamicRule": null
}
}

Contact Lists: Get

Returns a contact list's details, including its Entity ID and external identity when present.

For a Smart List, the response includes its rule, condition IDs, and current ruleRevision. Retrieve these values before updating the rule. The response does not include the contacts in the list.

Authorizations:

NoneNone

path Parameters

account required	string External account ID, or `me` for the credential's own account.
contactList required	string Yext-assigned resource UUID.

query Parameters

v

required

string^[0-9]{8}$

Default: "20240401"

API version date in YYYYMMDD format. Use one fixed date for your integration; supply this parameter once per request.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "7b4b7f0f-17cf-4bec-81b0-97a729f25e54",
"errors": [ ]
},
"response": {"displayName": "New York newsletter subscribers",
"description": "CRM-managed static audience for the New York branch.",
"entityId": "branch-nyc-001",
"kind": "CONTACT_LIST_KIND_STATIC",
"externalIdentity": {"source": "salesforce",
"externalId": "campaign-newsletter-nyc"
},
"name": "accounts/514581/contactLists/019a1234-5678-7000-8000-000000000002",
"uid": "019a1234-5678-7000-8000-000000000002",
"businessId": "514581",
"entityLabel": "New York Main Branch",
"ruleRevision": "0",
"createdAt": "2026-10-26T15:30:00Z",
"updatedAt": "2026-10-26T15:30:00Z",
"deletedAt": null,
"dynamicRule": null
}
}

Contact Lists: Delete

Archives a contact list without deleting its contacts.

You must have permission to manage the list for its account and Entity. A successful response contains an empty response object. There is no restore endpoint in this public API.

Authorizations:

NoneNone

path Parameters

account required	string External account ID, or `me` for the credential's own account.
contactList required	string Yext-assigned resource UUID.

query Parameters

v

required

string^[0-9]{8}$

Default: "20240401"

API version date in YYYYMMDD format. Use one fixed date for your integration; supply this parameter once per request.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "7b4b7f0f-17cf-4bec-81b0-97a729f25e54",
"errors": [ ]
},
"response": { }
}

Contact List Memberships: Create

Adds a contact to a static list. If the membership already exists, returns it without adding a duplicate.

Use the list UUID in the URL and the contact UUID in contactId. To use IDs from another system, supply those IDs and set externalIdentitySource to their source. UUIDs and external IDs can be combined; the source is required for each external ID. Values formatted as UUIDs are always interpreted as Yext-assigned IDs.

The contact and list must be active and belong to compatible Entity scopes you can manage. Smart List membership is determined by its rule and cannot be assigned manually.

To remove the membership later, use its returned name. The final segment is the contact ID, which differs from the membership's own uid.

Authorizations:

NoneNone

path Parameters

account required	string External account ID, or `me` for the credential's own account.
contactList required	string List UUID, or source-system list ID with `externalIdentitySource`.

query Parameters

v

required

string^[0-9]{8}$

Default: "20240401"

API version date in YYYYMMDD format. Use one fixed date for your integration; supply this parameter once per request.

Request Body schema: application/json

contactId required	string Resolved internal contact UUID.
externalIdentitySource	string Input-only namespace for external identifier resolution; not returned.

Responses

Request samples

Payload

Content type

application/json

{"contactId": "019a1234-5678-7000-8000-000000000001"
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "7b4b7f0f-17cf-4bec-81b0-97a729f25e54",
"errors": [ ]
},
"response": {"name": "accounts/514581/contactLists/019a1234-5678-7000-8000-000000000002/members/019a1234-5678-7000-8000-000000000001",
"uid": "019a1234-5678-7000-8000-000000000005",
"businessId": "514581",
"contactId": "019a1234-5678-7000-8000-000000000001",
"listId": "019a1234-5678-7000-8000-000000000002",
"createdAt": "2026-10-26T15:30:00Z",
"updatedAt": "2026-10-26T15:30:00Z"
}
}

Contact List Memberships: Delete

Removes a contact from a static list without deleting the contact.

Use the list UUID and contact UUID from the membership's returned name. The last URL segment is contactId, not the membership's own uid. Do not send a request body or externalIdentitySource.

A missing membership may return a not-found error. Smart List membership cannot be removed manually.

Authorizations:

NoneNone

path Parameters

account required	string External account ID, or `me` for the credential's own account.
contactList required	string Yext-assigned resource UUID.
member required	string Contact UUID, not the separate membership UID.

query Parameters

v

required

string^[0-9]{8}$

Default: "20240401"

API version date in YYYYMMDD format. Use one fixed date for your integration; supply this parameter once per request.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "7b4b7f0f-17cf-4bec-81b0-97a729f25e54",
"errors": [ ]
},
"response": { }
}

Contacts: Create

Creates a contact associated with a Knowledge Graph Entity.

Provide emailAddress and entityId in the request body. Send the contact fields directly, without a contact wrapper. Any custom-field definitions must already exist.

To synchronize contacts from another system, include externalIdentity. Reusing the same source and record ID updates the matching contact and can restore a deleted match. Without an external identity, this method creates a new contact.

If an error occurs after saving the contact, the write may still have succeeded. Check the contact before retrying.

Authorizations:

NoneNone

path Parameters

account

required

string

External account ID, or me for the credential's own account.

query Parameters

v

required

string^[0-9]{8}$

Default: "20240401"

API version date in YYYYMMDD format. Use one fixed date for your integration; supply this parameter once per request.

Request Body schema: application/json

firstName	string Optional first name. A blank/omitted name on PATCH clears that profile field.
lastName	string Optional last name.
emailAddress required	string Email address. Required when creating or updating a contact. Addresses are normalized and validated before saving.
title	string Optional professional title. Omitted/blank on PATCH clears it.
company	string Optional company. Omitted/blank on PATCH clears it.
entityId	string Entity ID from Knowledge Graph. Required on create and update. Send the exact ID as a string, including when it contains only digits.
	contactsContactCustomFields (object) or (object or null) Values for your account's defined contact custom fields. Omit on update to keep current values. An empty values object clears writable values, subject to restrictions on archived field definitions.
	contactsExternalIdentity (object) or (object or null) Contact identity in another system. Include on create to synchronize records with that system. Cannot be changed after creation.
middleName	string Optional middle name. Profile writes trim surrounding whitespace.
phoneNumber	string Optional phone number. Prefer E.164. National numbers require suitable phoneRegion context.
phoneRegion	string Input-only phone parsing region, for example US. Not returned in responses.

Responses

Request samples

Payload

Content type

application/json

{"firstName": "Alex",
"middleName": "Morgan",
"lastName": "Rivera",
"emailAddress": "alex.rivera@example.com",
"phoneNumber": "+12125550123",
"phoneRegion": "US",
"title": "Branch Manager",
"company": "Example Financial",
"entityId": "branch-nyc-001"
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "7b4b7f0f-17cf-4bec-81b0-97a729f25e54",
"errors": [ ]
},
"response": {"firstName": "Alex",
"middleName": "Morgan",
"lastName": "Rivera",
"emailAddress": "alex.rivera@example.com",
"phoneNumber": "+12125550123",
"title": "Branch Manager",
"company": "Example Financial",
"entityId": "branch-nyc-001",
"name": "accounts/514581/contacts/019a1234-5678-7000-8000-000000000001",
"uid": "019a1234-5678-7000-8000-000000000001",
"businessId": "514581",
"entityLabel": "New York Main Branch",
"lists": [ ],
"createdAt": "2026-10-26T15:30:00Z",
"updatedAt": "2026-10-26T15:30:00Z",
"deletedAt": null
}
}

Contacts: List

Returns contacts you have permission to access, with optional search, Entity, and list filters.

Use entityId for one Knowledge Graph Entity or selectedEntityScope for a broader selection. Entity IDs are the IDs from Knowledge Graph; folder and label IDs are numeric strings. Additional filters narrow this selection.

Use listId or listIds to include contacts from any of the selected lists. Repeat array query parameters once per value. Set deletedOnly=true to return archived contacts instead of active contacts.

Pass the returned nextPageToken as pageToken with the same filters to continue. Search and Smart List results may take time to reflect recent changes. The response does not include an exact total.

Authorizations:

NoneNone

path Parameters

account

required

string

External account ID, or me for the credential's own account.

query Parameters

query	string Search text used to narrow the results. Recent changes may take time to appear in search results.
pageSize	integer <int32> Requested page size. Nonpositive values use 50; above 1000 is capped.
pageToken	string Token returned in nextPageToken by the previous response. Keep the other search parameters unchanged. Omit for the first page.
listId	string Optional singular list UUID.
deletedOnly	boolean Archived contacts only when true; active contacts by default.
entityId	string Exact external Entity ID string; takes precedence over a broader selected entity scope.
selectedEntityScope.entityIds	Array of strings Knowledge Graph external entity IDs for this account.
selectedEntityScope.folderIds	Array of strings <int64>
selectedEntityScope.labelIds	Array of strings <int64>
ids	Array of strings Restrict results to these Yext-assigned UUIDs. Repeat ids once per UUID.
listIds	Array of strings Additional list UUIDs. Matches contacts in any of the selected lists.
v required	string^[0-9]{8}$ Default: "20240401" API version date in YYYYMMDD format. Use one fixed date for your integration; supply this parameter once per request.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "7b4b7f0f-17cf-4bec-81b0-97a729f25e54",
"errors": [ ]
},
"response": {"contacts": [{"firstName": "Alex",
"middleName": "Morgan",
"lastName": "Rivera",
"emailAddress": "alex.rivera@example.com",
"phoneNumber": "+12125550123",
"title": "Branch Manager",
"company": "Example Financial",
"entityId": "branch-nyc-001",
"externalIdentity": {"source": "salesforce",
"externalId": "003-example-0001"
},
"customFields": {"values": {"customer_tier": {"stringValue": "gold"
},
"marketing_opt_in": {"booleanValue": true
},
"annual_spend": {"numberValue": 1250.5
},
"renewal_date": {"stringValue": "2027-04-15"
}
}
},
"name": "accounts/514581/contacts/019a1234-5678-7000-8000-000000000001",
"uid": "019a1234-5678-7000-8000-000000000001",
"businessId": "514581",
"entityLabel": "New York Main Branch",
"lists": [ ],
"createdAt": "2026-10-26T15:30:00Z",
"updatedAt": "2026-10-26T15:30:00Z",
"deletedAt": null
}
],
"nextPageToken": ""
}
}

Contacts: Update

Updates a contact identified by its Yext-assigned UUID.

Provide the existing entityId and an emailAddress. The contact must be active and belong to that Entity. Send the profile fields directly; omit name from the body.

Important: This operation replaces ordinary profile values. Include all name, phone number, title, and company fields you want to keep. Omitted values are cleared. Read the contact first if you need to preserve its current profile.

Omit customFields to keep its values. If provided, its writable values replace the current set. The contact's externalIdentity cannot be changed.

Authorizations:

NoneNone

path Parameters

account required	string External account ID, or `me` for the credential's own account.
contact required	string Yext-assigned resource UUID.

query Parameters

v

required

string^[0-9]{8}$

Default: "20240401"

API version date in YYYYMMDD format. Use one fixed date for your integration; supply this parameter once per request.

Request Body schema: application/json

firstName	string Optional first name. A blank/omitted name on PATCH clears that profile field.
lastName	string Optional last name.
emailAddress required	string Email address. Required when creating or updating a contact. Addresses are normalized and validated before saving.
title	string Optional professional title. Omitted/blank on PATCH clears it.
company	string Optional company. Omitted/blank on PATCH clears it.
entityId	string Entity ID from Knowledge Graph. Required on create and update. Send the exact ID as a string, including when it contains only digits.
	contactsContactCustomFields (object) or (object or null) Values for your account's defined contact custom fields. Omit on update to keep current values. An empty values object clears writable values, subject to restrictions on archived field definitions.
	contactsExternalIdentity (object) or (object or null) Contact identity in another system. Include on create to synchronize records with that system. Cannot be changed after creation.
middleName	string Optional middle name. Profile writes trim surrounding whitespace.
phoneNumber	string Optional phone number. Prefer E.164. National numbers require suitable phoneRegion context.
phoneRegion	string Input-only phone parsing region, for example US. Not returned in responses.

Responses

Request samples

Payload

Content type

application/json

{"firstName": "Alex",
"middleName": "Morgan",
"lastName": "Rivera",
"emailAddress": "alex.rivera@example.com",
"phoneNumber": "+12125550123",
"phoneRegion": "US",
"title": "Senior Branch Manager",
"company": "Example Financial Services",
"entityId": "branch-nyc-001"
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "7b4b7f0f-17cf-4bec-81b0-97a729f25e54",
"errors": [ ]
},
"response": {"firstName": "Alex",
"middleName": "Morgan",
"lastName": "Rivera",
"emailAddress": "alex.rivera@example.com",
"phoneNumber": "+12125550123",
"title": "Senior Branch Manager",
"company": "Example Financial Services",
"entityId": "branch-nyc-001",
"externalIdentity": {"source": "salesforce",
"externalId": "003-example-0001"
},
"customFields": {"values": {"customer_tier": {"stringValue": "gold"
},
"marketing_opt_in": {"booleanValue": true
},
"annual_spend": {"numberValue": 1250.5
},
"renewal_date": {"stringValue": "2027-04-15"
}
}
},
"name": "accounts/514581/contacts/019a1234-5678-7000-8000-000000000001",
"uid": "019a1234-5678-7000-8000-000000000001",
"businessId": "514581",
"entityLabel": "New York Main Branch",
"lists": [ ],
"createdAt": "2026-10-26T15:30:00Z",
"updatedAt": "2026-10-26T15:30:00Z",
"deletedAt": null
}
}

Contacts: Get

Returns a contact's profile, Entity ID, and related contact lists.

Use the contact's Yext-assigned UUID in the URL. Your API key must have access to its account and Entity. Use this method to check a contact immediately after creating or updating it, before the change appears in search results.

To find archived contacts, use Contacts: List with deletedOnly=true.

Authorizations:

NoneNone

path Parameters

account required	string External account ID, or `me` for the credential's own account.
contact required	string Yext-assigned resource UUID.

query Parameters

v

required

string^[0-9]{8}$

Default: "20240401"

API version date in YYYYMMDD format. Use one fixed date for your integration; supply this parameter once per request.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "7b4b7f0f-17cf-4bec-81b0-97a729f25e54",
"errors": [ ]
},
"response": {"firstName": "Alex",
"middleName": "Morgan",
"lastName": "Rivera",
"emailAddress": "alex.rivera@example.com",
"phoneNumber": "+12125550123",
"title": "Branch Manager",
"company": "Example Financial",
"entityId": "branch-nyc-001",
"externalIdentity": {"source": "salesforce",
"externalId": "003-example-0001"
},
"customFields": {"values": {"customer_tier": {"stringValue": "gold"
},
"marketing_opt_in": {"booleanValue": true
},
"annual_spend": {"numberValue": 1250.5
},
"renewal_date": {"stringValue": "2027-04-15"
}
}
},
"name": "accounts/514581/contacts/019a1234-5678-7000-8000-000000000001",
"uid": "019a1234-5678-7000-8000-000000000001",
"businessId": "514581",
"entityLabel": "New York Main Branch",
"lists": [ ],
"createdAt": "2026-10-26T15:30:00Z",
"updatedAt": "2026-10-26T15:30:00Z",
"deletedAt": null
}
}

Contacts: Delete

Archives a contact identified by its Yext-assigned UUID.

You must have permission to manage contacts for its Entity. This operation does not permanently erase the contact. A successful response contains an empty response object.

Deleting an already archived or missing contact may return a not-found error. There is no restore endpoint in this public API.

Authorizations:

NoneNone

path Parameters

account required	string External account ID, or `me` for the credential's own account.
contact required	string Yext-assigned resource UUID.

query Parameters

v

required

string^[0-9]{8}$

Default: "20240401"

API version date in YYYYMMDD format. Use one fixed date for your integration; supply this parameter once per request.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "7b4b7f0f-17cf-4bec-81b0-97a729f25e54",
"errors": [ ]
},
"response": { }
}