PATCH /api/profiles/{id}
Update the profile with the given profile ID.
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.
The maximum allowed payload size is 100KB.
Rate limits:
Burst: 75/s
Steady: 700/m
Scopes:
profiles:write
Servers
- https://a.klaviyo.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
Primary key that uniquely identifies this profile. Generated by Klaviyo. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
revision |
String | Yes |
API endpoint revision (format: YYYY-MM-DD[.suffix]) Default value: "2025-04-15" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
additional-fieldsprofile[] |
Array | No |
Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.