Subscribers

Unsubscribe a subscriber

Changed on

Admin-initiated unsubscribe: sets unsubscribedAt and deactivates the subscriber’s alerts. Requires alerts.manage.

post/subscribers/{id}/unsubscribe

Request

  • Base URL: https://api.cavuno.com/v1
  • URL: https://api.cavuno.com/v1/subscribers/{id}/unsubscribe
  • Auth: HTTP bearer

Path parameters

idstring required

The subscriber ID.

Response

Successful response.

idstring required

Unique identifier for the subscriber.

object'subscriber' required

String representing the object's type.

emailstring required

The subscriber's email address.

confirmedAtstring nullable required

ISO-8601 timestamp of double-opt-in confirmation, or null.

waitlistedAtstring nullable required

ISO-8601 timestamp of when the subscriber was waitlisted.

unsubscribedAtstring nullable required

ISO-8601 timestamp of when the subscriber unsubscribed.

createdAtstring required

ISO-8601 timestamp of when the subscriber was created.

lastSentAtstring nullable required

ISO-8601 timestamp of the most recent alert dispatch, or null.

Changes

  • c34152c38176Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status