Sign in

v3

OpenAPI 3.1.02026-07-2759128137.8 KB
contacts

Update Contact Exclusion

Update mutable fields of a contact-level exclusion.

Requires the exclusions:write scope on the API key.

patch/v1/contact-exclusions/{exclusion_id}

Path parameters

exclusion_idstring uuid required

ID of the exclusion.

Request body

reason'BAD_TIMING' | 'BOUNCED' | 'COMPETITOR' | 'CONTACT_REFUSED' | 'INTERESTED' | 'MEETING' | 'OTHER' | 'OUT_OF_OFFICE' | 'UNKNOWN' | 'UNSUBSCRIBED' | 'WRONG_PERSON' | 'EXCLUDE_FROM_SEARCH' | 'EXCLUDE_FROM_CRM' | 'REFERRAL' | 'LEFT_COMPANY'
messagestring nullable

New operator note.

untilstring date-time nullable

New expiration timestamp. Pass null to make the exclusion permanent.

Response

Successful Response

idstring uuid required

Unique identifier.

emailstring nullable required

Excluded email.

linkedin_urlstring nullable required

Excluded LinkedIn URL.

reason'BAD_TIMING' | 'BOUNCED' | 'COMPETITOR' | 'CONTACT_REFUSED' | 'INTERESTED' | 'MEETING' | 'OTHER' | 'OUT_OF_OFFICE' | 'UNKNOWN' | 'UNSUBSCRIBED' | 'WRONG_PERSON' | 'EXCLUDE_FROM_SEARCH' | 'EXCLUDE_FROM_CRM' | 'REFERRAL' | 'LEFT_COMPANY' required
messagestring nullable required

Operator note.

untilstring date-time nullable required

When the exclusion expires.

created_atstring date-time required

When the exclusion was created.

updated_atstring date-time required

When the exclusion last changed.