Create Client Subscription

POST {{baseUrl}}/client/subscriptions/?company_id={{companyId}}

Create a new subscription for the given list ID and channel:

  • Email email
  • SMS phone_number

This endpoint is specifically designed to be called from publicly-browseable, client-side environments only. To create subscriptions from server-based applications, please use POST /api/profile-subscription-bulk-create-jobs

Rate limits:
Burst: 100/s
Steady: 700/m

Scopes: subscriptions:write

Request Params

KeyDatatypeRequiredDescription
company_idstring(Required) Your Public API Key / Site ID. See this article for more details.

Request Body

{"data"=>{"type"=>"subscription", "attributes"=>{"list_id"=>"<string>", "custom_source"=>"<string>", "email"=>"<string>", "phone_number"=>"<string>"}}}

HEADERS

KeyDatatypeRequiredDescription
revisionstring(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])
Content-Typestring