Opt-outs

List people who must not be messaged

Numbers on the workspace's opt-out list, oldest first. A number gets here two ways: the person wrote a stop word such as "STOP" in a direct chat (source: inbound_keyword), or you added it (source: api). Sends to a number on the list are refused with RECIPIENT_OPTED_OUT, and so are messages already queued or scheduled for it.

get/v1/opt-outs

Request

  • Base URL: https://www.chatrail.dev
  • URL: https://www.chatrail.dev/v1/opt-outs
  • Auth: HTTP bearer

Query parameters

limitinteger
cursorstring uuid

Response

A page of opt-outs, with next_cursor when there is more.

Changes

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