latestOpenAPI 3.0.02026-08-10416661.5 MB

e96b3e58b041

Contacts

Opt-out contact

REQUIRED SCOPES <code>['contacts:write']</code><br>An opt-out contact means a contact being disabled for reaching out. In case a contact is currently opt-in, i.e. enabled, this request makes this contact unavailable for communication.<br><br> As a result, the current user cannot send messages to the contact from the application, which is also reflected with the following note on the current user’s side bar: <br><br> This contact has been opted-out and will not receive messages from local and tall-free numbers.<br><br> At the same time, the contact themselves can write to the user.

put/contacts/opt-out/{contact}

Path parameters

contactinteger required

Contact id

Response

OK

idinteger

Returns the contact in array format.

owner_idinteger
colorstring
first_namestring
last_namestring
full_namestring
emailstring
photo_urlstring
numberstring
countrystring
country_calling_codestring
national_numberstring
typeted_numberstring
is_blockedboolean
opt_outboolean
opt_out_atstring
opt_in_request_atstring
opt_in_atstring
created_atstring
updated_atstring
integration_vendor_idinteger
prevent_autolinkboolean