Create Client Subscription
POST {{baseUrl}}/client/subscriptions/?company_id={{companyId}}
Rate limits:
Burst: 100/s
Steady: 700/m
Scopes:
subscriptions:write
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
company_id | string | (Required) Your Public API Key / Site ID. See this article for more details. |
Request Body
{"data"=>{"type"=>"subscription", "attributes"=>{"profile"=>{"data"=>{"type"=>"profile", "attributes"=>{"email"=>"<string>", "phone_number"=>"<string>", "external_id"=>"<string>", "anonymous_id"=>"<string>", "first_name"=>"<string>", "last_name"=>"<string>", "organization"=>"<string>", "title"=>"<string>", "image"=>"<string>", "location"=>{"address1"=>"<string>", "address2"=>"<string>", "city"=>"<string>", "country"=>"<string>", "latitude"=>"<string>", "longitude"=>"<string>", "region"=>"<string>", "zip"=>"<string>", "timezone"=>"<string>", "ip"=>"<string>"}, "meta"=>{"patch_properties"=>{"unset"=>"<string>"}}}, "id"=>"<string>"}}, "custom_source"=>"<string>"}, "relationships"=>{"list"=>{"data"=>{"type"=>"list", "id"=>"<string>"}}}}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Content-Type | string |