Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Unsubscribed

UnsubscribedPhones.update

Modifies UnsubscribedPhone or UnsubscribedPhones with given id(s)

patch/entities/UnsubscribedPhones/{id}

Path parameters

idstring uuid required

ID of UnsubscribedPhone to update

Query parameters

validation-levelinteger

Specify validation level of UnsubscribedPhone on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

phonestring

Phone number that has unsubscribed from receiving SMS messages, in E.164 format.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "phone": "string",
  "revision": 1
}

Response

Modification confirmation. Returns resulting UnsubscribedPhone

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "phone": "string",
    "revision": 1
  }
}