v93

OpenAPI 3.1.0raw.githubusercontent.com2026-08-01218121759.7 KB

Subscribers

Add tag to subscriber

Adds a tag to a subscriber. Creates the subscriber if they don't exist. Creates the tag definition if it doesn't exist. When the workspace has double opt-in enabled, a brand-new subscriber is created pending confirmation, the confirmation email is queued, and tag automations wait at their trigger until the subscriber confirms.

post/subscribers/tags

Request body

emailstring email

Required when creating a new subscriber. Optional when externalId identifies an existing subscriber.

externalIdstring

Customer-owned app/customer/user ID

firstNamestring

First name to set if creating the subscriber.

lastNamestring

Last name to set if creating the subscriber.

tagstring required

customAttributesobject

Optional attributes to set on the subscriber if created

Example request

{
  "email": "user@example.com",
  "externalId": "user_123",
  "firstName": "John",
  "lastName": "Doe",
  "tag": "premium"
}

Response

Tag added successfully

successboolean

Example response

{
  "success": true
}