Skip to main content
POST
Python
Use this endpoint whenever a contact tells you they want to stop receiving marketing: a reply to your own bot, a support ticket, a form on your site. Minimo then stops marketing sends to that contact exactly as if they had used an unsubscribe link or told Minimo’s AI assistant.
Only marketing consent is withdrawn. Transactional and utility messages (order updates, account emails, approved utility WhatsApp templates) keep working.

Which channels are withdrawn

The result depends on your company’s opt-out scope (Settings → Contacts): The response tells you which scope was applied and which channels were withdrawn, so you can confirm it to the contact in your own words (for example “Done, you won’t receive offers from us any more”).

Identifying the contact

Send exactly one of:
  • phone: E.164 or digits only. With a WhatsApp bot, pass the contact.phone from the inbound webhook envelope. channel defaults to whatsapp.
  • email: case-insensitive. channel defaults to email.
  • contactId: the Minimo contact id. channel is required.
The contact is always looked up inside the company that owns your API key.

Permissions

Any API key with the subscribe, transactional or whatsapp permission can call it. A WhatsApp-only key, the one used by bots connected through Connect Your Bot, is enough.

Common Errors

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
phone
string

Phone number, E.164 or digits only (e.g. the contact.phone of the inbound webhook envelope).

Example:

"393391234567"

email
string<email>

Email address of the contact (case-insensitive).

contactId
integer

Minimo contact id. Requires channel.

channel
enum<string>

Channel the contact asked on. Defaults to whatsapp for phone and email for email; required with contactId.

Available options:
whatsapp,
email,
sms
reason
string

Optional context for the consent audit trail, e.g. the customer's message.

Maximum string length: 500

Response

Opt-out recorded

data
object