Create or Update Client Push Token

POST {{baseUrl}}/client/push-tokens/?company_id={{companyId}}

Create or update a push token.

This endpoint is designed to be called from our mobile SDKs (iOS and Android). You must have push notifications enabled to use this endpoint.

Rate limits:
Burst: 3/s
Steady: 60/m

Request Params

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

Request Body

{"data"=>{"type"=>"push-token", "attributes"=>{"token"=>"<string>", "platform"=>"ios", "vendor"=>"apns", "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>"}}, "enablement_status"=>"AUTHORIZED", "background"=>"AVAILABLE", "device_metadata"=>{"device_id"=>"<string>", "klaviyo_sdk"=>"swift", "sdk_version"=>"<string>", "device_model"=>"<string>", "os_name"=>"ipados", "os_version"=>"<string>", "manufacturer"=>"<string>", "app_name"=>"<string>", "app_version"=>"<string>", "app_build"=>"<string>", "app_id"=>"<string>", "environment"=>"debug"}}}}

HEADERS

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