API Reference

Add Unsubscribes (V2)

post
https://optitext-sms-service-api-us.optimove.net/v2/sms/unsubscribes

Upserts one or more customer unsubscribe records. Valid entries are persisted with consent = false (unsubscribed). Invalid mobile numbers are skipped; see response codes for partial-success behavior.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

JSON array of customer unsubscribe entries. Maximum 250 entries per request.

string
required
length ≤ 255

Unique customer identifier within the tenant/app.

string
required
length ≤ 255

Mobile number validated against ^\+?[1-9]\d{3,14}$ (optional leading +, first digit 1–9, 4–15 digits total). Invalid numbers are rejected with the E.164 error responses below.

date-time

Optional event timestamp (RFC 3339, e.g. 2020-06-09T05:32:21Z). The API also accepts other date strings parseable by Laravel, such as 2020-06-09 05:32:21. If omitted, the server uses the current time. Updates are only applied when this value is newer than the existing record's updated_at.

Responses

401

Missing or invalid API key / server key

429

Rate limit exceeded. Limited to 6000 requests per minute per Authorization header.

Updated about 12 hours ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 12 hours ago