Sign in

v3

OpenAPI 3.1.02026-07-2759128137.8 KB
contacts

Create Contact Exclusion

Create a new contact-level exclusion.

Requires the exclusions:write scope on the API key.

post/v1/contact-exclusions

Request body

emailstring nullable

Email to exclude. At least one of email or linkedin_url is required.

linkedin_urlstring nullable

LinkedIn URL to exclude. At least one of email or linkedin_url is required.

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

Free-form note for operators.

untilstring date-time nullable

When the exclusion expires. Omit for a permanent exclusion.

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.