Unsubscribe a contact

Unsubscribe a contact by ID.

Authorizations

Bearer API key

string

headerrequired

The API key used to authenticate requests, learn how to generate an API key on the Authentication page.

Path Parameters

teamId

string

required

Team ID, starting with tea_

contactId

string

required

Contact ID, starting with con_

Response

200 - application/json

id

string

The unique ID of the contact, starting with con_.

createdAt

string

The date and time the contact was created.

updatedAt

string

The date and time the contact was last updated.

blockedAt

string

The date and time the contact was unsubscribed.

name

string

The full name of the contact.

nickname

string

The nickname of the contact, e.g., the first name.

bio

string

The bio of the contact.

avatar

string

The URL of the avatar of the contact.

website

string

The URL of the personal website of the contact.

location

string

The residential location of the contact.

timeZone

string

The time zone of the contact in the IANA time zone database format.

city

string

The city of the contact's residential location.

state

string

The state of the contact's residential location.

countryCode

string

The country code of the contact's residential location in the ISO 3166-1 alpha-2 format.

latitude

number

The latitude of the contact's residential location.

longitude

number

The longitude of the contact's residential location.

employmentTitle

string

The current job title of the contact.

employmentSeniority

enum<string>

The seniority level of the contact in their current job.

Available options:

c_suite,

director,

entry,

founder,

head,

intern,

manager,

owner,

partner,

senior,

vp

companyId

string

The unique ID of the company the contact works at, starting with com_.

rootContactId

string

The globally unique ID of the root contact, starting with rcn_.