Unsubscribe from a Flow's email notifications

Unsubscribe an email address from Flow notifications.

Public, token-authenticated endpoint that backs the unsubscribe link in every Agentic Flows notification email. No API key or account is required: authorization is carried entirely by the signed token, which encodes the Flow, the Send Email node, and the recipient address. Idempotent — removing an address that is no longer subscribed still succeeds. The token must have been issued for the {id} in the path.

{
  "token": "<signed-unsubscribe-token>"
}
Path Params
string
required

Flow ID (must match the Flow encoded in the token).

Body Params

The signed unsubscribe token from the email link.

string
required

The signed unsubscribe token from the email link.

Headers
string

Not required for this endpoint.

string

Optional. ID of the group whose API quota should be charged for the request. If omitted, the parent group's quota is used. Only relevant when your API key belongs to more than one group (multi-tenancy).

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json