Lift a block
Lift a block you added, or a marketing block made in WhatsApp. The entry stays in the list with active: false. A customer's own STOP cannot be lifted over the API: only the customer lifting it in WhatsApp, or messaging you again, brings them back.
Set up WhatsApp first. Connect a WhatsApp number in the dashboard or with Connect numbers. Included on every paid plan. See plans.
number_idrequiredopt_out_idrequiredcurl -X DELETE 'https://backend.omnidim.io/api/v1/whatsapp/numbers/{number_id}/opt_outs/{opt_out_id}' \ -H 'Authorization: Bearer YOUR_API_KEY'
{ "id": 0, "phone_number_id": 0, "customer": "+15551234567", "source": "instructed_keyword", "active": false, "opted_out_at": "string", "opted_in_at": "string", "note": "string" }
BearerAuthAuthorizationBearer <token>Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
number_id*integerId of a WhatsApp number in your workspace, from
listWhatsappNumbers.
A number in another workspace answers 404.
opt_out_id*integerId of an active opt-out entry, from listWhatsappOptOuts.
Response body
application/jsonThe block was lifted.
application/jsonid?integerphone_number_id?integercustomer?stringsource?stringHow the opt-out happened. instructed_keyword and
template_stop_button are the customer's own and only they can
lift them. meta_marketing_optout is a marketing choice made in
WhatsApp. manual is one you added.
"instructed_keyword""template_stop_button""meta_marketing_optout""manual"active?booleanopted_out_at?stringopted_in_at?stringWhen a lifted opt-out was lifted.
note?stringBlock a customer
Stop every message you start to this customer from this number, until the block is lifted. The response is 201 when the block is new and 200 when the customer was already blocked, in which case the entry is returned unchanged.
List campaigns
Your WhatsApp campaigns, oldest first. Filter by status or by number.
