Skip to main content
Send the contact’s full list of restricted channels: it replaces the current one. Channels are any of email, sms, whatsapp and phone_voice (phone calls). Duplicates are dropped and the response lists the channels sorted. Send an empty list to lift every restriction.
To add or lift a single channel, read restricted_channels from Get contact first, then send the new full list.
  • The API key needs the contacts:write scope.
  • A contact ID that isn’t in your organization returns 404.
  • A change moves the contact’s updated_at forward, so List contacts with updated_after picks it up. Sending the list the contact already has changes and records nothing.
  • Every change is recorded in the audit log with the before and after lists, who made it and from where. See Audit Logs API.
  • Changing restricted channels doesn’t fire the Contact Updated workflow trigger.
Once a channel is restricted, a send to the contact on it is refused with HTTP 422 and error: "contact_channel_restricted"; see refused sends. Replies in a session the contact started on that channel are still delivered. Restricted channels explains what a restriction stops and what still goes through.