Create or Update Profile

post https://a.klaviyo.com/api/profile-import

Given a set of profile attributes and optionally an ID, create or update a profile.

Returns 201 if a new profile was created, 200 if an existing profile was updated.

Use the additional-fields parameter to include subscriptions and predictive analytics data in your response.

Note that setting a field to null will clear out the field, whereas not including a field in your request will leave it unchanged.

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

Scopes:
profiles:write

Responses

Language

Credentials

Header


xxxxxxxxxx
13
1
curl --request POST \
2
     --url https://a.klaviyo.com/api/profile-import \
3
     --header 'Authorization: Klaviyo-API-Key your-private-api-key' \
4
     --header 'accept: application/vnd.api+json' \
5
     --header 'content-type: application/vnd.api+json' \
6
     --header 'revision: 2024-10-15' \
7
     --data '
8
{
9
  "data": {
10
    "type": "profile"
11
  }
12
}
13
'


xxxxxxxxxx
127
}
1
{
2
  "data": {
3
    "type": "profile",
4
    "id": "01GDDKASAP8TKDDA2GRZDSVP4H",
5
    "attributes": {
6
      "email": "sarah.mason@klaviyo-demo.com",
7
      "phone_number": "+15005550006",
8
      "external_id": "string",
9
      "first_name": "Sarah",
10
      "last_name": "Mason",
11
      "organization": "Example Corporation",
12
      "locale": "en-US",
13
      "title": "Regional Manager",
14
      "image": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
15
      "created": "2022-11-08T00:00:00+00:00",
16
      "updated": "2022-11-08T00:00:00+00:00",
17
      "last_event_date": "2022-11-08T00:00:00+00:00",
18
      "location": {
19
        "address1": "89 E 42nd St",
20
        "address2": "1st floor",
21
        "city": "New York",
22
        "country": "United States",
23
        "latitude": "string",
24
        "longitude": "string",
25
        "region": "NY",

200Profile Updated Successfully

201Profile Created Successfully

4XXClient Error

5XXServer Error