accounts

Update Account Exclusion

Changed on

Update mutable fields of an account-level exclusion.

Requires the account_exclusions:write scope on the API key.

patch/v1/account-exclusions/{exclusion_id}

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/account-exclusions/{exclusion_id}
  • Auth: HTTP bearer

Path parameters

exclusion_idstring uuid required

ID of the exclusion.

Request body

reason'BAD_TIMING' | 'BOUNCED' | 'COMPETITOR' | 'CONTACT_REFUSED' | 'INTERESTED' | 'MEETING' | 'NOT_INTERESTED' | '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.

domainstring nullable required

Excluded account domain.

reason'BAD_TIMING' | 'BOUNCED' | 'COMPETITOR' | 'CONTACT_REFUSED' | 'INTERESTED' | 'MEETING' | 'NOT_INTERESTED' | '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.

Changes

  • 4c947c3f2e11Revision changes
    • warning

      added the new NOT_INTERESTED enum value to the response property for the response status

    • info

      added the new NOT_INTERESTED enum value to the request property /