VEverdun
sms-consent

List Optout Events

Durable STOP events. A non-empty unresolved list is why SMS may be refusing every send.

get/sms-consent/optout-events

Request

  • Base URL
    https://api.verdun.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.verdun.ai/sms-consent/optout-events
  • Auth
    HTTP bearer

Query parameters

unresolved_onlyboolean

Response

Successful Response

idstring uuid required

Unique identifier of the opt-out event.

webhook_idstring required

Surge's signed webhook-id; the replay key.

surge_contact_idstring required

The Surge contact that opted out.

event_tsstring date-time required

When the opt-out occurred, frozen at first insert.

phone_numberstring nullable

The number, once PROVEN to belong to the contact. NULL until then.

resolved_atstring date-time nullable

When it was reconciled.

resolution_errorstring nullable

Why the last resolution attempt proved nothing.

attempt_countinteger required

Resolution attempts so far.

last_attempt_atstring date-time nullable

Most recent attempt.

escalated_atstring date-time nullable

When this was escalated for human attention.

created_atstring date-time nullable

Row creation time.

updated_atstring date-time nullable

Row last-update time.

Changes

No recorded changes to this operation across all 2 revisions of this API.