Unsubscribe from a Flow

Remove a recipient from a flow, stopping any further emails in the sequence.

POST https://api.notifiedby.com/v1/flows/unsubscribe/

Request Body:

{
    "flow_trigger": "WELCOME_SIGNUP",
    "email": "user@example.com"
}

Field

Required

Description

flow_trigger

Yes

The trigger keyword of the flow to unsubscribe from.

email

Yes

The recipient’s email address.

Success Response (200):

{
    "detail": "Recipient 'user@example.com' successfully unsubscribed from flow 'Welcome Signup Flow'."
}

Example with curl:

curl -X POST https://api.notifiedby.com/v1/flows/unsubscribe/ \
    -H "Authorization: Api-Key YOUR_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{"flow_trigger": "WELCOME_SIGNUP", "email": "user@example.com"}'