Opt-Outs
Remove Opt-Outs
Re-enable contacts who consented again — the suppressions this API recorded, and with confirmed consent, STOP replies and unsubscribe buttons ↩️
POST
Remove Opt-Outs
Endpoint
Request body
entries array (required)
Each object names one WhatsApp contact to re-enable. Maximum 10,000 per request.
The same contact listed twice counts once.
consentConfirmed
consentConfirmed never clears an opt-out the contact set in WhatsApp’s own marketing settings, nor one added from a file upload in the dashboard.
consentConfirmed must be enabled for your business first. Contact Connectly support to turn it on. Until then, a request with consentConfirmed: true is refused with HTTP 400 and nothing changes. See Consent not enabled.Examples
Re-enable by phone number
Re-enable by phone number
Re-enable by Business-Scoped User ID
Re-enable by Business-Scoped User ID
Re-enable contacts who replied STOP, after collecting new consent
Re-enable contacts who replied STOP, after collecting new consent
Response
The API returns HTTP200 with a data object. Counts are over the contacts you named.
Success response
A large
notOptedOutCount is normal and is not an error. If you send your full consented list every night, every contact you never suppressed through this API lands there.Marketing opt-outs
marketingOptOutCount reports contacts that Connectly keeps suppressed because they turned off marketing messages from your business in WhatsApp. No template message reaches them, utility included, until they turn marketing messages back on in WhatsApp. This API cannot do it for them.
- It counts the identifiers you sent, not distinct contacts. A contact named by both its phone number and its BSUID counts twice.
- It is reported whether or not you set
consentConfirmed. - It overlaps the other counts. A contact here can also be in
removedCount, when another opt-out was cleared, or innotOptedOutCount. - It is
0when Connectly could not complete the check. The removal still applies.
Error responses
Unreadable entries are dropped and counted — they do not fail the batch. The request fails outright only when no entry survives.
Rejection reasons are the same as Add opt-outs.
Consent not enabled
A request that setsconsentConfirmed: true before Connectly has enabled it for your business fails with HTTP 400 and error code XOPTOUT.CONSENT_NOT_ENABLED. Nothing is cleared, including the opt-outs this API added, so a failed request never looks like a partial success. Contact Connectly support to enable it, then send the request again.
Rate limiting
This endpoint is limited to 60 requests per minute. Exceeding this returns HTTP429 Too Many Requests.