Create Profile
POST {{baseUrl}}/api/profiles/
Create a new profile.
If you use a phone number as the profile identifier and SMS is not set up in the Klaviyo account,
you'll need to include at least one other identifier attribute (email or external_id)
in addition to the phone_number attribute for the API call to work.
Rate limits:
Burst: 75/s
Steady: 700/m
Scopes:
profiles:write
Request Body
{"data"=>{"type"=>"profile", "attributes"=>{"email"=>"<string>", "phone_number"=>"<string>", "external_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>"}}}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"data":{"type":"profile","attributes":{"email":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","external_id":"\u003cstring\u003e","first_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e","organization":"\u003cstring\u003e","title":"\u003cstring\u003e","image":"\u003cstring\u003e","created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e","last_event_date":"\u003cdateTime\u003e","location":{"address1":"\u003cstring\u003e","address2":"\u003cstring\u003e","city":"\u003cstring\u003e","country":"\u003cstring\u003e","latitude":"\u003cstring\u003e","longitude":"\u003cstring\u003e","region":"\u003cstring\u003e","zip":"\u003cstring\u003e","timezone":"\u003cstring\u003e","ip":"\u003cstring\u003e"},"properties":{},"subscriptions":{"email":{"marketing":{"can_receive_email_marketing":"\u003cboolean\u003e","consent":"\u003cstring\u003e","consent_timestamp":"\u003cdateTime\u003e","last_updated":"\u003cdateTime\u003e","method":"\u003cstring\u003e","method_detail":"","custom_method_detail":"\u003cstring\u003e","double_optin":"\u003cboolean\u003e","suppression":[{"reason":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e"},{"reason":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e"}],"list_suppressions":[{"list_id":"\u003cstring\u003e","reason":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e"},{"list_id":"\u003cstring\u003e","reason":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e"}]}},"sms":{"marketing":{"can_receive_sms_marketing":"\u003cboolean\u003e","consent":"\u003cstring\u003e","consent_timestamp":"\u003cdateTime\u003e","method":"\u003cstring\u003e","last_updated":"\u003cdateTime\u003e","method_detail":""}}},"predictive_analytics":{"historic_clv":"\u003cnumber\u003e","predicted_clv":"\u003cnumber\u003e","total_clv":"\u003cnumber\u003e","historic_number_of_orders":"\u003cinteger\u003e","predicted_number_of_orders":"\u003cnumber\u003e","average_days_between_orders":"\u003cnumber\u003e","average_order_value":"\u003cnumber\u003e","churn_probability":"\u003cnumber\u003e","expected_date_of_next_order":"\u003cdateTime\u003e"}},"links":{"self":"\u003curi\u003e"},"id":"\u003cstring\u003e","relationships":{"lists":{"data":[{"type":"list","id":"\u003cstring\u003e"},{"type":"list","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"segments":{"data":[{"type":"segment","id":"\u003cstring\u003e"},{"type":"segment","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}}}