MCP is live.Set upAsk the community
OmniDimension
WhatsApp

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.

DELETE/whatsapp/numbers//opt_outs/
Path parameters
number_idrequired
opt_out_idrequired
curl -X DELETE 'https://backend.omnidim.io/api/v1/whatsapp/numbers/{number_id}/opt_outs/{opt_out_id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'
Example response
synthetic
{
  "id": 0,
  "phone_number_id": 0,
  "customer": "+15551234567",
  "source": "instructed_keyword",
  "active": false,
  "opted_out_at": "string",
  "opted_in_at": "string",
  "note": "string"
}

Authorization

BearerAuth
headerAuthorizationBearer <token>

Bearer token authentication. Obtain your API key from the OmniDimension dashboard.

Path Parameters

number_id*integer

Id of a WhatsApp number in your workspace, from listWhatsappNumbers. A number in another workspace answers 404.

opt_out_id*integer

Id of an active opt-out entry, from listWhatsappOptOuts.

Response body

application/json

Response Body

The block was lifted.

application/json
id?integer
phone_number_id?integer
customer?string
source?string

How 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.

Value in"instructed_keyword""template_stop_button""meta_marketing_optout""manual"
active?boolean
opted_out_at?string
opted_in_at?string

When a lifted opt-out was lifted.

note?string