Subscribe Contact

post

https://api.campaignrefinery.com/rest/contacts/subscribe

Creates a new contact (or updates an existing one keyed by email) for the authenticated account, applies tag/sequence/form/goal mappings, and resolves any provided custom attributes. Pass create_only: true to fail with HTTP 400 instead of upserting when a contact with the same email already exists -- this replaces the legacy /rest/contacts/create-contact endpoint, which was an alias of subscribe with the flag pre-set. Pass domain to route the subscription to a sub-account in the same billing group.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

string

required

length ≤ 255

The contact's email address. Required. Validated against email:rfc,dns.

string | null

Optional. Existing contact UUID. If supplied and the contact exists, its email is updated to match the submitted email before the upsert runs.

first_name

string | null

The contact's first name. If omitted, falls back to splitting name at the first space.

last_name

string | null

The contact's last name. If omitted, falls back to the second half of name.

name

string | null

Single field carrying both first and last name. Used as a fallback when first_name / last_name are not provided.

200Contact subscribed (created or upserted).

400Subscription failed. Common causes: invalid input, contact already exists when create_only is true, account / domain resolution failure.

422Validation error (e.g. missing email, email not RFC-valid, custom attribute type out of the allowed enum, custom attribute key longer than 100 chars).