v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Contacts

Add a Contact Tag

Adds a tag to the contact. Added tags display on the Tags tab of the contact’s profile page. Tags may comprise the information that can help to further categorize the contact and make the contact’s profile more searchable.

post/v1/contact/{contactId}/tags

Path parameters

contactIdstring required

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Request body

tagIdinteger

The identifier for the tag.

tagNamestring

The name of the tag.

contactIdinteger

The identifier for the contact.

Example request

{
  "tagId": 12345,
  "tagName": "Hospitality"
}

Response

The created contact tag.