Skip to content
LeadPattern
Reference/Contacts/Update Opt-Out Status

Update Opt-Out Status

PATCHhttps://public.leadpattern.com/customer/:waId/opt-out
application/json60 req/min

Opt a contact in or out of messaging.

  • Opting out stamps optOutMethod: manual and excludes the contact from every broadcast.

Headers

1 field
Authorizationstring
required
Your API key. Sent raw (e.g. 'lp_...'). No Bearer prefix required.

Path Parameters

1 field
waIdstring
required
Contact WhatsApp ID.

Body Parameters

1 field
optOutboolean
required
true to opt out, false to opt back in.

Responses

JSON Response
{
  "type": "success",
  "message": "Contact opted out."
}

Sample Request Body

{
  "optOut": true
}
← Previous Endpoint
Archive / Unarchive Chat
Next Endpoint →
List Chats