v1

latestOpenAPI 3.0.12026-07-24210349345.4 KB

SMS Unsubscribes

Add Unsubscribes (V2)

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.

post/v2/sms/unsubscribes

Request body

customerIdstring required

Unique customer identifier within the tenant/app.

mobileNumberstring required

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.

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

Example request

[
  {
    "customerId": "customer-123",
    "mobileNumber": "+12345678901",
    "timestamp": "2020-06-09T05:32:21Z"
  }
]

Response

All entries processed successfully

messagestring

Example response

{
  "message": "Data inserted/updated successfully."
}