Compliance

Request opt-out of email and/or SMS

At least one of email / phone. If a valid token (from the email link) is present AND email is unchanged from the token's address, the marketing opt-out is processed immediately and status is "unsubscribed". Otherwise it's recorded for admin review and status is "received". Public (no login).

post/api/v1/compliance/unsubscribe

Request

  • Base URL: https://api.juju.com
  • URL: https://api.juju.com/api/v1/compliance/unsubscribe
  • Auth: none declared

Request body

emailstring email nullable
phonestring nullable
tokenstring nullable

From the email unsubscribe link; enables the verified auto-process.

Response

{status:"unsubscribed"} (verified) or {status:"received"} (queued for review).

dataunknown required
metaobject required

Pagination and context metadata. Always present, empty object ({}) when no metadata applies to the response.

errorsstring[] required

Empty array on success. On failure, human-readable error strings suitable for surfacing to end users.

Example response

{
  "errors": []
}

Changes

No recorded changes to this operation across all 1 revision of this API.