Create or Update a Recipient

Create a new recipient or update an existing one. If a recipient with the given email already exists for your team, their details will be updated.

POST https://api.notifiedby.com/v1/recipients/

Request Body:

{
    "email": "user@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "flags": ["premium", "active"]
}

Field	Required	Description
email	Yes	The recipient’s email address.
first_name	No	The recipient’s first name.
last_name	No	The recipient’s last name.
flags	No	A list of flags to set on the recipient. Can also be a comma-separated string.

Success Response (201):

{
    "sqid": "abc123",
    "email": "user@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "flags": ["premium", "active"],
    "has_been_sent_email": false,
    "created_at": "2026-02-17T09:00:00Z",
    "updated_at": "2026-02-17T09:00:00Z"
}

Example with curl:

curl -X POST https://api.notifiedby.com/v1/recipients/ \
    -H "Authorization: Api-Key YOUR_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{"email": "user@example.com", "first_name": "John", "last_name": "Doe", "flags": ["premium"]}'