authenticated
crm

Contact Stop Policy

Every live stop standing against this contact, at every level.

The boolean on ContactPublic says whether outreach is off; this says what turned it off, so the office can tell a campaign opt-out from a number the carrier blocked from a request to be removed entirely.

get/crm/contacts/{contact_id}/stop-policy

Request

  • Base URL
    https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

contact_idstring required

Headers

organization-idstring nullable
x-user-idstring nullable
timezonestring
x-actor-emailstring nullable
x-request-sourcestring nullable
x-operation-idstring nullable
x-commit-messagestring nullable
x-confirmation-idstring nullable
x-chat-idstring nullable

Response

Successful Response

do_not_contactboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.