Remove an opt-out
remove_opt_outDeletes a phone number from an account's opt-out list so SMS, MMS, or RCS messages can be sent again—only after the person has explicitly opted back in, such as texting START.
Instructions
Allow messages to a number again by deleting it from this account's opt-out list on a channel (DELETE /api/v1/sms/opt-outs/{phone}); the reverse of add_opt_out. Only do this when the person has explicitly opted back in (for example by texting START): messaging someone who opted out breaks consent rules. Requires VOBIZ_ENABLE_MESSAGING=true on the server and confirm: true. Check the current state first with check_opt_out.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| channel | No | sms (default; also covers mms), mms or rcs. | |
| confirm | Yes | Must be true after the user confirmed this person opted back in. | |
| phone_number | Yes | The number to unblock, E.164 (leading + optional). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | No | True on success; false when the result is an error (then error, message and retryable are set). | |
| channel | No | Channel the change applies to: sms, mms or rcs. | |
| opted_out | No | Always false: the number can be messaged again. | |
| phone_number | No | The number, normalised to E.164. |