{ "info": { "_postman_id": "c31c18d9-16fa-4aff-ab58-b62bb41e29ee", "name": "Klaviyo Accounts Client API", "description": "The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.\n\nContact Support:\n Name: Klaviyo Developer Experience Team\n Email: developers@klaviyo.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "lastUpdatedBy": "35240", "uid": "35240-c31c18d9-16fa-4aff-ab58-b62bb41e29ee" }, "item": [ { "name": "client", "item": [ { "name": "review-values-reports", "item": [ { "name": "Get Client Review Values Reports", "id": "2168e14a-dbbe-4da7-81a5-56454190cc11", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/client/review-values-reports?company_id=&fields[review-values-report]=results,results&filter=&group_by=product_id&page[cursor]=&page[size]=20&statistics=&timeframe=last_365_days", "host": [ "{{baseUrl}}" ], "path": [ "client", "review-values-reports" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[review-values-report]", "value": "results,results" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`product_external_ids`: `any`, `equals`", "key": "filter", "value": "" }, { "description": "(Required) group by value for this report", "key": "group_by", "value": "product_id" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination", "key": "page[cursor]", "value": "" }, { "description": "Default: 20. Min: 1. Max: 100.", "key": "page[size]", "value": "20" }, { "description": "(Required) list of statistics to calculate for this report", "key": "statistics", "value": "" }, { "description": "(Required) timeframe window for value report", "key": "timeframe", "value": "last_365_days" } ] }, "description": "Get all reviews values reports in an account.

*Rate limits*:
Burst: `10/s`
Steady: `150/m`" }, "response": [ { "id": "dd3f1f2a-a9c4-4342-ad61-62c503e50213", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/client/review-values-reports?company_id=&fields[review-values-report]=results,results&filter=&group_by=product_id&page[cursor]=&page[size]=20&statistics=&timeframe=last_365_days", "host": [ "{{baseUrl}}" ], "path": [ "client", "review-values-reports" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[review-values-report]", "value": "results,results" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`product_external_ids`: `any`, `equals`", "key": "filter", "value": "" }, { "description": "(Required) group by value for this report", "key": "group_by", "value": "product_id" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination", "key": "page[cursor]", "value": "" }, { "description": "Default: 20. Min: 1. Max: 100.", "key": "page[size]", "value": "20" }, { "description": "(Required) list of statistics to calculate for this report", "key": "statistics", "value": "" }, { "description": "(Required) timeframe window for value report", "key": "timeframe", "value": "last_365_days" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"type\": \"review-values-report\",\n \"id\": \"\",\n \"attributes\": {\n \"results\": [\n {\n \"groupings\": {\n \"product_id\": \"\"\n },\n \"statistics\": {\n \"average_rating\": \"\",\n \"total_reviews\": \"\",\n \"total_questions\": \"\",\n \"total_ratings\": \"\",\n \"total_store_reviews\": \"\",\n \"average_store_rating\": \"\"\n }\n },\n {\n \"groupings\": {\n \"product_id\": \"\"\n },\n \"statistics\": {\n \"average_rating\": \"\",\n \"total_reviews\": \"\",\n \"total_questions\": \"\",\n \"total_ratings\": \"\",\n \"total_store_reviews\": \"\",\n \"average_store_rating\": \"\"\n }\n }\n ]\n },\n \"links\": {\n \"self\": \"\"\n }\n },\n {\n \"type\": \"review-values-report\",\n \"id\": \"\",\n \"attributes\": {\n \"results\": [\n {\n \"groupings\": {\n \"product_id\": \"\"\n },\n \"statistics\": {\n \"average_rating\": \"\",\n \"total_reviews\": \"\",\n \"total_questions\": \"\",\n \"total_ratings\": \"\",\n \"total_store_reviews\": \"\",\n \"average_store_rating\": \"\"\n }\n },\n {\n \"groupings\": {\n \"product_id\": \"\"\n },\n \"statistics\": {\n \"average_rating\": \"\",\n \"total_reviews\": \"\",\n \"total_questions\": \"\",\n \"total_ratings\": \"\",\n \"total_store_reviews\": \"\",\n \"average_store_rating\": \"\"\n }\n }\n ]\n },\n \"links\": {\n \"self\": \"\"\n }\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"first\": \"\",\n \"last\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n }\n}", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-dd3f1f2a-a9c4-4342-ad61-62c503e50213" }, { "id": "3545476d-91a8-403b-a879-0252efb1b2a4", "name": "Client Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/client/review-values-reports?company_id=&fields[review-values-report]=results,results&filter=&group_by=product_id&page[cursor]=&page[size]=20&statistics=&timeframe=last_365_days", "host": [ "{{baseUrl}}" ], "path": [ "client", "review-values-reports" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[review-values-report]", "value": "results,results" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`product_external_ids`: `any`, `equals`", "key": "filter", "value": "" }, { "description": "(Required) group by value for this report", "key": "group_by", "value": "product_id" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination", "key": "page[cursor]", "value": "" }, { "description": "Default: 20. Min: 1. Max: 100.", "key": "page[size]", "value": "20" }, { "description": "(Required) list of statistics to calculate for this report", "key": "statistics", "value": "" }, { "description": "(Required) timeframe window for value report", "key": "timeframe", "value": "last_365_days" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-3545476d-91a8-403b-a879-0252efb1b2a4" }, { "id": "e0f16e03-54e7-46df-96e1-13868f243f3b", "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/client/review-values-reports?company_id=&fields[review-values-report]=results,results&filter=&group_by=product_id&page[cursor]=&page[size]=20&statistics=&timeframe=last_365_days", "host": [ "{{baseUrl}}" ], "path": [ "client", "review-values-reports" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[review-values-report]", "value": "results,results" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`product_external_ids`: `any`, `equals`", "key": "filter", "value": "" }, { "description": "(Required) group by value for this report", "key": "group_by", "value": "product_id" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination", "key": "page[cursor]", "value": "" }, { "description": "Default: 20. Min: 1. Max: 100.", "key": "page[size]", "value": "20" }, { "description": "(Required) list of statistics to calculate for this report", "key": "statistics", "value": "" }, { "description": "(Required) timeframe window for value report", "key": "timeframe", "value": "last_365_days" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-e0f16e03-54e7-46df-96e1-13868f243f3b" } ], "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-2168e14a-dbbe-4da7-81a5-56454190cc11" } ], "id": "cdd32254-0666-4988-abf6-f308bbd35f89", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-cdd32254-0666-4988-abf6-f308bbd35f89" }, { "name": "reviews", "item": [ { "name": "Get Client Reviews", "id": "1ec7e15f-480b-4028-b851-e01c4c40551a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/client/reviews?company_id=&fields[review]=content,product.url&filter=&page[cursor]=&page[size]=20&sort=-rating", "host": [ "{{baseUrl}}" ], "path": [ "client", "reviews" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[review]", "value": "content,product.url" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`status`: `equals`
`review_type`: `equals`
`rating`: `any`, `equals`, `greater-or-equal`, `less-or-equal`
`id`: `any`, `equals`
`content`: `contains`
`smart_quote`: `has`
`public_reply`: `has`
`verified`: `equals`
`incentivized`: `equals`
`edited`: `equals`
`media`: `has`
`created`: `greater-or-equal`, `less-or-equal`
`updated`: `greater-or-equal`, `less-or-equal`", "key": "filter", "value": "" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination", "key": "page[cursor]", "value": "" }, { "description": "Default: 20. Min: 1. Max: 100.", "key": "page[size]", "value": "20" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting", "key": "sort", "value": "-rating" } ] }, "description": "Get all reviews. This endpoint is for client-side environments only, for server-side use, refer to https://developers.klaviyo.com/en/reference/get_reviews

*Rate limits*:
Burst: `10/s`
Steady: `150/m`" }, "response": [ { "id": "02fd36da-bee6-404b-9489-61f9da6c9234", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/client/reviews?company_id=&fields[review]=content,product.url&filter=&page[cursor]=&page[size]=20&sort=-rating", "host": [ "{{baseUrl}}" ], "path": [ "client", "reviews" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[review]", "value": "content,product.url" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`status`: `equals`
`review_type`: `equals`
`rating`: `any`, `equals`, `greater-or-equal`, `less-or-equal`
`id`: `any`, `equals`
`content`: `contains`
`smart_quote`: `has`
`public_reply`: `has`
`verified`: `equals`
`incentivized`: `equals`
`edited`: `equals`
`media`: `has`
`created`: `greater-or-equal`, `less-or-equal`
`updated`: `greater-or-equal`, `less-or-equal`", "key": "filter", "value": "" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination", "key": "page[cursor]", "value": "" }, { "description": "Default: 20. Min: 1. Max: 100.", "key": "page[size]", "value": "20" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting", "key": "sort", "value": "-rating" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"type\": \"review\",\n \"id\": \"\",\n \"attributes\": {\n \"verified\": \"\",\n \"review_type\": \"review\",\n \"created\": \"\",\n \"updated\": \"\",\n \"images\": [\n \"\",\n \"\"\n ],\n \"status\": {\n \"value\": \"rejected\",\n \"rejection_reason\": {\n \"reason\": \"other\",\n \"status_explanation\": \"\"\n }\n },\n \"product\": {\n \"url\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"external_id\": \"\"\n },\n \"rating\": \"\",\n \"author\": \"\",\n \"content\": \"\",\n \"title\": \"\",\n \"smart_quote\": \"\",\n \"public_reply\": {\n \"content\": \"\",\n \"author\": \"\",\n \"updated\": \"\"\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n },\n {\n \"type\": \"review\",\n \"id\": \"\",\n \"attributes\": {\n \"verified\": \"\",\n \"review_type\": \"review\",\n \"created\": \"\",\n \"updated\": \"\",\n \"images\": [\n \"\",\n \"\"\n ],\n \"status\": {\n \"value\": \"rejected\",\n \"rejection_reason\": {\n \"reason\": \"other\",\n \"status_explanation\": \"\"\n }\n },\n \"product\": {\n \"url\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"external_id\": \"\"\n },\n \"rating\": \"\",\n \"author\": \"\",\n \"content\": \"\",\n \"title\": \"\",\n \"smart_quote\": \"\",\n \"public_reply\": {\n \"content\": \"\",\n \"author\": \"\",\n \"updated\": \"\"\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"first\": \"\",\n \"last\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n }\n}", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-02fd36da-bee6-404b-9489-61f9da6c9234" }, { "id": "f716a7ac-1c6c-440d-ae91-f905638248d7", "name": "Client Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/client/reviews?company_id=&fields[review]=content,product.url&filter=&page[cursor]=&page[size]=20&sort=-rating", "host": [ "{{baseUrl}}" ], "path": [ "client", "reviews" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[review]", "value": "content,product.url" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`status`: `equals`
`review_type`: `equals`
`rating`: `any`, `equals`, `greater-or-equal`, `less-or-equal`
`id`: `any`, `equals`
`content`: `contains`
`smart_quote`: `has`
`public_reply`: `has`
`verified`: `equals`
`incentivized`: `equals`
`edited`: `equals`
`media`: `has`
`created`: `greater-or-equal`, `less-or-equal`
`updated`: `greater-or-equal`, `less-or-equal`", "key": "filter", "value": "" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination", "key": "page[cursor]", "value": "" }, { "description": "Default: 20. Min: 1. Max: 100.", "key": "page[size]", "value": "20" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting", "key": "sort", "value": "-rating" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-f716a7ac-1c6c-440d-ae91-f905638248d7" }, { "id": "6c413a0e-470b-4ac8-b001-cee37335f48c", "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/client/reviews?company_id=&fields[review]=content,product.url&filter=&page[cursor]=&page[size]=20&sort=-rating", "host": [ "{{baseUrl}}" ], "path": [ "client", "reviews" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[review]", "value": "content,product.url" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`status`: `equals`
`review_type`: `equals`
`rating`: `any`, `equals`, `greater-or-equal`, `less-or-equal`
`id`: `any`, `equals`
`content`: `contains`
`smart_quote`: `has`
`public_reply`: `has`
`verified`: `equals`
`incentivized`: `equals`
`edited`: `equals`
`media`: `has`
`created`: `greater-or-equal`, `less-or-equal`
`updated`: `greater-or-equal`, `less-or-equal`", "key": "filter", "value": "" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination", "key": "page[cursor]", "value": "" }, { "description": "Default: 20. Min: 1. Max: 100.", "key": "page[size]", "value": "20" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting", "key": "sort", "value": "-rating" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-6c413a0e-470b-4ac8-b001-cee37335f48c" } ], "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-1ec7e15f-480b-4028-b851-e01c4c40551a" }, { "name": "Create Client Review", "id": "8026dd1b-d9fa-4954-b2e4-fbb6a195e255", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"review\",\n \"attributes\": {\n \"review_type\": \"review\",\n \"email\": \"\",\n \"author\": \"\",\n \"content\": \"\",\n \"incentive_type\": \"employee_review\",\n \"product\": {\n \"external_id\": \"\",\n \"integration_key\": \"shopify\"\n },\n \"rating\": 5,\n \"title\": \"\",\n \"custom_questions\": [\n {\n \"id\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"images\": [\n \"\",\n \"\"\n ]\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/reviews?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "reviews" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] }, "description": "Create a review with the given ID. This endpoint is for client-side environments only.

*Rate limits*:
Burst: `10/s`
Steady: `150/m`" }, "response": [ { "id": "0da47f65-e195-47ca-ae2d-361317ee1d6f", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"review\",\n \"attributes\": {\n \"review_type\": \"review\",\n \"email\": \"\",\n \"author\": \"\",\n \"content\": \"\",\n \"incentive_type\": \"employee_review\",\n \"product\": {\n \"external_id\": \"\",\n \"integration_key\": \"shopify\"\n },\n \"rating\": 5,\n \"title\": \"\",\n \"custom_questions\": [\n {\n \"id\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"images\": [\n \"\",\n \"\"\n ]\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/reviews?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "reviews" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-0da47f65-e195-47ca-ae2d-361317ee1d6f" }, { "id": "ea707ea0-fa17-4f0f-9182-b145460fb49e", "name": "Client Error", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"review\",\n \"attributes\": {\n \"review_type\": \"review\",\n \"email\": \"\",\n \"author\": \"\",\n \"content\": \"\",\n \"incentive_type\": \"employee_review\",\n \"product\": {\n \"external_id\": \"\",\n \"integration_key\": \"shopify\"\n },\n \"rating\": 5,\n \"title\": \"\",\n \"custom_questions\": [\n {\n \"id\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"images\": [\n \"\",\n \"\"\n ]\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/reviews?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "reviews" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-ea707ea0-fa17-4f0f-9182-b145460fb49e" }, { "id": "e19b5985-d859-4691-9489-d2b888431a39", "name": "Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"review\",\n \"attributes\": {\n \"review_type\": \"review\",\n \"email\": \"\",\n \"author\": \"\",\n \"content\": \"\",\n \"incentive_type\": \"employee_review\",\n \"product\": {\n \"external_id\": \"\",\n \"integration_key\": \"shopify\"\n },\n \"rating\": 5,\n \"title\": \"\",\n \"custom_questions\": [\n {\n \"id\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"images\": [\n \"\",\n \"\"\n ]\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/reviews?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "reviews" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-e19b5985-d859-4691-9489-d2b888431a39" } ], "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-8026dd1b-d9fa-4954-b2e4-fbb6a195e255" } ], "id": "6856afb4-f7eb-4d6c-8703-81da8a8b04b5", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-6856afb4-f7eb-4d6c-8703-81da8a8b04b5" }, { "name": "geofences", "item": [ { "name": "Get Client Geofences", "id": "d4220a69-f10c-44a9-aa6d-ddf03cd2b780", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "\nSupported filters:\n- `lat` (equals) - Latitude coordinate for distance-based sorting\n- `lng` (equals) - Longitude coordinate for distance-based sorting\n\nWhen both lat and lng are provided, geofences are returned sorted by\ndistance from the specified coordinates (closest first).\n", "key": "X-Klaviyo-API-Filters", "value": "" }, { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/client/geofences?company_id=&fields[geofence]=longitude,latitude&page[cursor]=&page[size]=20", "host": [ "{{baseUrl}}" ], "path": [ "client", "geofences" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[geofence]", "value": "longitude,latitude" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination", "key": "page[cursor]", "value": "" }, { "description": "Default: 20. Min: 1. Max: 100.", "key": "page[size]", "value": "20" } ] }, "description": "Get all geofences in an account.\n\nReturns a paginated list of all geofences for the specified company.\nThis is the GA API endpoint designed for mobile SDK consumption.\nNo authentication required.\n\nReturns a maximum of 100 results per page (default 20).\n\nThis API supports filtering via header instead of query param. Provide\n`X-Klaviyo-API-Filters` header to filter geofences. We don't use regular\nquery param filters here because lat and long are sensitive information.\n\nSupported filters:\n- `lat` (equals) - Latitude coordinate for distance-based sorting\n- `lng` (equals) - Longitude coordinate for distance-based sorting\n\nWhen both lat and lng are provided, geofences are returned sorted by\ndistance from the specified coordinates (closest first).\n\nExample filter header:\n`X-Klaviyo-API-Filters: and(equals(lat,40.7128),equals(lng,-74.0060))`

*Rate limits*:
Burst: `3/s`
Steady: `60/m`" }, "response": [ { "id": "88b6759d-523c-43ce-a1e2-b8f50aaa5ae3", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "\nSupported filters:\n- `lat` (equals) - Latitude coordinate for distance-based sorting\n- `lng` (equals) - Longitude coordinate for distance-based sorting\n\nWhen both lat and lng are provided, geofences are returned sorted by\ndistance from the specified coordinates (closest first).\n", "key": "X-Klaviyo-API-Filters", "value": "" }, { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/client/geofences?company_id=&fields[geofence]=longitude,latitude&page[cursor]=&page[size]=20", "host": [ "{{baseUrl}}" ], "path": [ "client", "geofences" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[geofence]", "value": "longitude,latitude" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination", "key": "page[cursor]", "value": "" }, { "description": "Default: 20. Min: 1. Max: 100.", "key": "page[size]", "value": "20" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"type\": \"geofence\",\n \"id\": \"\",\n \"attributes\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"radius\": \"\"\n },\n \"links\": {\n \"self\": \"\"\n }\n },\n {\n \"type\": \"geofence\",\n \"id\": \"\",\n \"attributes\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"radius\": \"\"\n },\n \"links\": {\n \"self\": \"\"\n }\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"first\": \"\",\n \"last\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n }\n}", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-88b6759d-523c-43ce-a1e2-b8f50aaa5ae3" }, { "id": "963b8697-bc25-412e-a9d0-46233bcc1773", "name": "Client Error", "originalRequest": { "method": "GET", "header": [ { "description": "\nSupported filters:\n- `lat` (equals) - Latitude coordinate for distance-based sorting\n- `lng` (equals) - Longitude coordinate for distance-based sorting\n\nWhen both lat and lng are provided, geofences are returned sorted by\ndistance from the specified coordinates (closest first).\n", "key": "X-Klaviyo-API-Filters", "value": "" }, { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/client/geofences?company_id=&fields[geofence]=longitude,latitude&page[cursor]=&page[size]=20", "host": [ "{{baseUrl}}" ], "path": [ "client", "geofences" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[geofence]", "value": "longitude,latitude" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination", "key": "page[cursor]", "value": "" }, { "description": "Default: 20. Min: 1. Max: 100.", "key": "page[size]", "value": "20" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-963b8697-bc25-412e-a9d0-46233bcc1773" }, { "id": "3e5a5ac4-3506-40f6-9714-aeeeb6ea393f", "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "\nSupported filters:\n- `lat` (equals) - Latitude coordinate for distance-based sorting\n- `lng` (equals) - Longitude coordinate for distance-based sorting\n\nWhen both lat and lng are provided, geofences are returned sorted by\ndistance from the specified coordinates (closest first).\n", "key": "X-Klaviyo-API-Filters", "value": "" }, { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/client/geofences?company_id=&fields[geofence]=longitude,latitude&page[cursor]=&page[size]=20", "host": [ "{{baseUrl}}" ], "path": [ "client", "geofences" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[geofence]", "value": "longitude,latitude" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination", "key": "page[cursor]", "value": "" }, { "description": "Default: 20. Min: 1. Max: 100.", "key": "page[size]", "value": "20" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-3e5a5ac4-3506-40f6-9714-aeeeb6ea393f" } ], "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-d4220a69-f10c-44a9-aa6d-ddf03cd2b780" } ], "id": "349536e6-b0f9-4271-a564-ac2332b3fe03", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-349536e6-b0f9-4271-a564-ac2332b3fe03" }, { "name": "subscriptions", "item": [ { "name": "Create Client Subscription", "id": "fcea2d07-205d-4124-af78-a5fb68256734", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription\",\n \"attributes\": {\n \"profile\": {\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"external_id\": \"\",\n \"_kx\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization\": \"\",\n \"locale\": \"\",\n \"title\": \"\",\n \"image\": \"\",\n \"location\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"region\": \"\",\n \"zip\": \"\",\n \"timezone\": \"\",\n \"ip\": \"\"\n },\n \"properties\": {},\n \"meta\": {\n \"patch_properties\": {\n \"append\": {},\n \"unappend\": {},\n \"unset\": \"\"\n },\n \"patch_identifiers\": {\n \"append\": {},\n \"unappend\": {}\n }\n },\n \"subscriptions\": {\n \"email\": {\n \"marketing\": {\n \"consent\": \"SUBSCRIBED\",\n \"consented_at\": \"\"\n }\n },\n \"sms\": {\n \"marketing\": {\n \"consent\": \"SUBSCRIBED\",\n \"consented_at\": \"\"\n },\n \"transactional\": {\n \"consent\": \"SUBSCRIBED\",\n \"consented_at\": \"\"\n }\n },\n \"whatsapp\": {\n \"marketing\": {\n \"consent\": \"SUBSCRIBED\",\n \"consented_at\": \"\"\n },\n \"transactional\": {\n \"consent\": \"SUBSCRIBED\",\n \"consented_at\": \"\"\n }\n },\n \"push\": {\n \"marketing\": {\n \"consent\": \"SUBSCRIBED\",\n \"consented_at\": \"\"\n },\n \"tokens\": [\n {\n \"token\": \"\",\n \"platform\": \"android\",\n \"vendor\": \"fcm\",\n \"enablement_status\": \"DENIED\",\n \"background\": \"DENIED\",\n \"device_metadata\": {\n \"device_id\": \"\",\n \"klaviyo_sdk\": \"react_native\",\n \"sdk_version\": \"\",\n \"device_model\": \"\",\n \"os_name\": \"ios\",\n \"os_version\": \"\",\n \"manufacturer\": \"\",\n \"app_name\": \"\",\n \"app_version\": \"\",\n \"app_build\": \"\",\n \"app_id\": \"\",\n \"environment\": \"release\"\n }\n },\n {\n \"token\": \"\",\n \"platform\": \"android\",\n \"vendor\": \"apns\",\n \"enablement_status\": \"NOT_DETERMINED\",\n \"background\": \"RESTRICTED\",\n \"device_metadata\": {\n \"device_id\": \"\",\n \"klaviyo_sdk\": \"android\",\n \"sdk_version\": \"\",\n \"device_model\": \"\",\n \"os_name\": \"tvos\",\n \"os_version\": \"\",\n \"manufacturer\": \"\",\n \"app_name\": \"\",\n \"app_version\": \"\",\n \"app_build\": \"\",\n \"app_id\": \"\",\n \"environment\": \"debug\"\n }\n }\n ],\n \"anonymous_id\": \"\"\n }\n }\n },\n \"id\": \"\"\n }\n },\n \"custom_source\": \"\"\n },\n \"relationships\": {\n \"list\": {\n \"data\": {\n \"type\": \"list\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/subscriptions?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "subscriptions" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] }, "description": "Creates a subscription and consent record for email and/or SMS channels based on the provided `email` and `phone_number` attributes, respectively. One of either `email` or `phone_number` must be provided.\n\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\n\nDo not use this endpoint from server-side applications.\nTo subscribe profiles from server-side applications, instead use [POST /api/profile-subscription-bulk-create-jobs](https://developers.klaviyo.com/en/reference/subscribe_profiles).\n\nProfiles can be opted into multiple channels: email marketing, SMS marketing, and SMS transactional. You can specify the channel(s) to subscribe the profile to by providing a subscriptions object in the profile attributes.\n\nIf you include a subscriptions object, only channels in that object will be subscribed. You can use this to update `email` or `phone` on the profile without subscribing them, for example, by setting the profile property but omitting that channel in the subscriptions object. If a subscriptions object is not provided, subscriptions are defaulted to `MARKETING`.

*Rate limits*:
Burst: `350/s`
Steady: `750/m`\n\n**Scopes:**\n`subscriptions:write`" }, "response": [ { "id": "d94bc1ec-5310-48ce-98c6-67743bef30ec", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription\",\n \"attributes\": {\n \"profile\": {\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"external_id\": \"\",\n \"_kx\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization\": \"\",\n \"locale\": \"\",\n \"title\": \"\",\n \"image\": \"\",\n \"location\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"region\": \"\",\n \"zip\": \"\",\n \"timezone\": \"\",\n \"ip\": \"\"\n },\n \"properties\": {},\n \"meta\": {\n \"patch_properties\": {\n \"append\": {},\n \"unappend\": {},\n \"unset\": \"\"\n },\n \"patch_identifiers\": {\n \"append\": {},\n \"unappend\": {}\n }\n },\n \"subscriptions\": {\n \"email\": {\n \"marketing\": {\n \"consent\": \"SUBSCRIBED\",\n \"consented_at\": \"\"\n }\n },\n \"sms\": {\n \"marketing\": {\n \"consent\": \"SUBSCRIBED\",\n \"consented_at\": \"\"\n },\n \"transactional\": {\n \"consent\": \"SUBSCRIBED\",\n \"consented_at\": \"\"\n }\n },\n \"whatsapp\": {\n \"marketing\": {\n \"consent\": \"SUBSCRIBED\",\n \"consented_at\": \"\"\n },\n \"transactional\": {\n \"consent\": \"SUBSCRIBED\",\n \"consented_at\": \"\"\n }\n },\n \"push\": {\n \"marketing\": {\n \"consent\": \"SUBSCRIBED\",\n \"consented_at\": \"\"\n },\n \"tokens\": [\n {\n \"token\": \"\",\n \"platform\": \"android\",\n \"vendor\": \"fcm\",\n \"enablement_status\": \"DENIED\",\n \"background\": \"DENIED\",\n \"device_metadata\": {\n \"device_id\": \"\",\n \"klaviyo_sdk\": \"react_native\",\n \"sdk_version\": \"\",\n \"device_model\": \"\",\n \"os_name\": \"ios\",\n \"os_version\": \"\",\n \"manufacturer\": \"\",\n \"app_name\": \"\",\n \"app_version\": \"\",\n \"app_build\": \"\",\n \"app_id\": \"\",\n \"environment\": \"release\"\n }\n },\n {\n \"token\": \"\",\n \"platform\": \"android\",\n \"vendor\": \"apns\",\n \"enablement_status\": \"NOT_DETERMINED\",\n \"background\": \"RESTRICTED\",\n \"device_metadata\": {\n \"device_id\": \"\",\n \"klaviyo_sdk\": \"android\",\n \"sdk_version\": \"\",\n \"device_model\": \"\",\n \"os_name\": \"tvos\",\n \"os_version\": \"\",\n \"manufacturer\": \"\",\n \"app_name\": \"\",\n \"app_version\": \"\",\n \"app_build\": \"\",\n \"app_id\": \"\",\n \"environment\": \"debug\"\n }\n }\n ],\n \"anonymous_id\": \"\"\n }\n }\n },\n \"id\": \"\"\n }\n },\n \"custom_source\": \"\"\n },\n \"relationships\": {\n \"list\": {\n \"data\": {\n \"type\": \"list\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/subscriptions?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "subscriptions" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-d94bc1ec-5310-48ce-98c6-67743bef30ec" }, { "id": "28b1d3f2-5d71-4ec4-b781-c50c9b4c023d", "name": "Client Error", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription\",\n \"attributes\": {\n \"profile\": {\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"external_id\": \"\",\n \"_kx\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization\": \"\",\n \"locale\": \"\",\n \"title\": \"\",\n \"image\": \"\",\n \"location\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"region\": \"\",\n \"zip\": \"\",\n \"timezone\": \"\",\n \"ip\": \"\"\n },\n \"properties\": {},\n \"meta\": {\n \"patch_properties\": {\n \"append\": {},\n \"unappend\": {},\n \"unset\": \"\"\n },\n \"patch_identifiers\": {\n \"append\": {},\n \"unappend\": {}\n }\n },\n \"subscriptions\": {\n \"email\": {\n \"marketing\": {\n \"consent\": \"SUBSCRIBED\",\n \"consented_at\": \"\"\n }\n },\n \"sms\": {\n \"marketing\": {\n \"consent\": \"SUBSCRIBED\",\n \"consented_at\": \"\"\n },\n \"transactional\": {\n \"consent\": \"SUBSCRIBED\",\n \"consented_at\": \"\"\n }\n },\n \"whatsapp\": {\n \"marketing\": {\n \"consent\": \"SUBSCRIBED\",\n \"consented_at\": \"\"\n },\n \"transactional\": {\n \"consent\": \"SUBSCRIBED\",\n \"consented_at\": \"\"\n }\n },\n \"push\": {\n \"marketing\": {\n \"consent\": \"SUBSCRIBED\",\n \"consented_at\": \"\"\n },\n \"tokens\": [\n {\n \"token\": \"\",\n \"platform\": \"android\",\n \"vendor\": \"fcm\",\n \"enablement_status\": \"DENIED\",\n \"background\": \"DENIED\",\n \"device_metadata\": {\n \"device_id\": \"\",\n \"klaviyo_sdk\": \"react_native\",\n \"sdk_version\": \"\",\n \"device_model\": \"\",\n \"os_name\": \"ios\",\n \"os_version\": \"\",\n \"manufacturer\": \"\",\n \"app_name\": \"\",\n \"app_version\": \"\",\n \"app_build\": \"\",\n \"app_id\": \"\",\n \"environment\": \"release\"\n }\n },\n {\n \"token\": \"\",\n \"platform\": \"android\",\n \"vendor\": \"apns\",\n \"enablement_status\": \"NOT_DETERMINED\",\n \"background\": \"RESTRICTED\",\n \"device_metadata\": {\n \"device_id\": \"\",\n \"klaviyo_sdk\": \"android\",\n \"sdk_version\": \"\",\n \"device_model\": \"\",\n \"os_name\": \"tvos\",\n \"os_version\": \"\",\n \"manufacturer\": \"\",\n \"app_name\": \"\",\n \"app_version\": \"\",\n \"app_build\": \"\",\n \"app_id\": \"\",\n \"environment\": \"debug\"\n }\n }\n ],\n \"anonymous_id\": \"\"\n }\n }\n },\n \"id\": \"\"\n }\n },\n \"custom_source\": \"\"\n },\n \"relationships\": {\n \"list\": {\n \"data\": {\n \"type\": \"list\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/subscriptions?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "subscriptions" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-28b1d3f2-5d71-4ec4-b781-c50c9b4c023d" }, { "id": "b4b9450f-8375-4ac4-8c9e-5711beefb548", "name": "Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription\",\n \"attributes\": {\n \"profile\": {\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"external_id\": \"\",\n \"_kx\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization\": \"\",\n \"locale\": \"\",\n \"title\": \"\",\n \"image\": \"\",\n \"location\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"region\": \"\",\n \"zip\": \"\",\n \"timezone\": \"\",\n \"ip\": \"\"\n },\n \"properties\": {},\n \"meta\": {\n \"patch_properties\": {\n \"append\": {},\n \"unappend\": {},\n \"unset\": \"\"\n },\n \"patch_identifiers\": {\n \"append\": {},\n \"unappend\": {}\n }\n },\n \"subscriptions\": {\n \"email\": {\n \"marketing\": {\n \"consent\": \"SUBSCRIBED\",\n \"consented_at\": \"\"\n }\n },\n \"sms\": {\n \"marketing\": {\n \"consent\": \"SUBSCRIBED\",\n \"consented_at\": \"\"\n },\n \"transactional\": {\n \"consent\": \"SUBSCRIBED\",\n \"consented_at\": \"\"\n }\n },\n \"whatsapp\": {\n \"marketing\": {\n \"consent\": \"SUBSCRIBED\",\n \"consented_at\": \"\"\n },\n \"transactional\": {\n \"consent\": \"SUBSCRIBED\",\n \"consented_at\": \"\"\n }\n },\n \"push\": {\n \"marketing\": {\n \"consent\": \"SUBSCRIBED\",\n \"consented_at\": \"\"\n },\n \"tokens\": [\n {\n \"token\": \"\",\n \"platform\": \"android\",\n \"vendor\": \"fcm\",\n \"enablement_status\": \"DENIED\",\n \"background\": \"DENIED\",\n \"device_metadata\": {\n \"device_id\": \"\",\n \"klaviyo_sdk\": \"react_native\",\n \"sdk_version\": \"\",\n \"device_model\": \"\",\n \"os_name\": \"ios\",\n \"os_version\": \"\",\n \"manufacturer\": \"\",\n \"app_name\": \"\",\n \"app_version\": \"\",\n \"app_build\": \"\",\n \"app_id\": \"\",\n \"environment\": \"release\"\n }\n },\n {\n \"token\": \"\",\n \"platform\": \"android\",\n \"vendor\": \"apns\",\n \"enablement_status\": \"NOT_DETERMINED\",\n \"background\": \"RESTRICTED\",\n \"device_metadata\": {\n \"device_id\": \"\",\n \"klaviyo_sdk\": \"android\",\n \"sdk_version\": \"\",\n \"device_model\": \"\",\n \"os_name\": \"tvos\",\n \"os_version\": \"\",\n \"manufacturer\": \"\",\n \"app_name\": \"\",\n \"app_version\": \"\",\n \"app_build\": \"\",\n \"app_id\": \"\",\n \"environment\": \"debug\"\n }\n }\n ],\n \"anonymous_id\": \"\"\n }\n }\n },\n \"id\": \"\"\n }\n },\n \"custom_source\": \"\"\n },\n \"relationships\": {\n \"list\": {\n \"data\": {\n \"type\": \"list\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/subscriptions?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "subscriptions" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-b4b9450f-8375-4ac4-8c9e-5711beefb548" } ], "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-fcea2d07-205d-4124-af78-a5fb68256734" } ], "id": "b744c6de-aeec-4781-ba16-001791231fe1", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-b744c6de-aeec-4781-ba16-001791231fe1" }, { "name": "push-tokens", "item": [ { "name": "Create or Update Client Push Token", "id": "425f08cb-43ae-4632-822d-1cc002b8adae", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"push-token\",\n \"attributes\": {\n \"token\": \"\",\n \"platform\": \"ios\",\n \"vendor\": \"apns\",\n \"profile\": {\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"phone_number\": \"\",\n \"external_id\": \"\",\n \"_kx\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization\": \"\",\n \"locale\": \"\",\n \"title\": \"\",\n \"image\": \"\",\n \"location\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"region\": \"\",\n \"zip\": \"\",\n \"timezone\": \"\",\n \"ip\": \"\"\n },\n \"properties\": {},\n \"meta\": {\n \"patch_properties\": {\n \"append\": {},\n \"unappend\": {},\n \"unset\": \"\"\n },\n \"patch_identifiers\": {\n \"append\": {},\n \"unappend\": {}\n }\n },\n \"email\": \"\"\n },\n \"id\": \"\"\n }\n },\n \"enablement_status\": \"AUTHORIZED\",\n \"background\": \"AVAILABLE\",\n \"device_metadata\": {\n \"device_id\": \"\",\n \"klaviyo_sdk\": \"flutter\",\n \"sdk_version\": \"\",\n \"device_model\": \"\",\n \"os_name\": \"tvos\",\n \"os_version\": \"\",\n \"manufacturer\": \"\",\n \"app_name\": \"\",\n \"app_version\": \"\",\n \"app_build\": \"\",\n \"app_id\": \"\",\n \"environment\": \"release\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/push-tokens?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "push-tokens" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] }, "description": "Create or update a push token.\n\nThis endpoint is specifically designed to be called from our mobile SDKs ([iOS](https://github.com/klaviyo/klaviyo-swift-sdk) and [Android](https://github.com/klaviyo/klaviyo-android-sdk)) and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\nYou must have push notifications enabled to use this endpoint.\n\nTo migrate push tokens from another platform to Klaviyo, please use our server-side [POST /api/push-tokens](https://developers.klaviyo.com/en/reference/create_push_token) endpoint instead.

*Rate limits*:
Burst: `150/s`
Steady: `1400/m`" }, "response": [ { "id": "ab2729b3-01a5-488d-96dd-7bd497d5a9f3", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"push-token\",\n \"attributes\": {\n \"token\": \"\",\n \"platform\": \"ios\",\n \"vendor\": \"apns\",\n \"profile\": {\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"phone_number\": \"\",\n \"external_id\": \"\",\n \"_kx\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization\": \"\",\n \"locale\": \"\",\n \"title\": \"\",\n \"image\": \"\",\n \"location\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"region\": \"\",\n \"zip\": \"\",\n \"timezone\": \"\",\n \"ip\": \"\"\n },\n \"properties\": {},\n \"meta\": {\n \"patch_properties\": {\n \"append\": {},\n \"unappend\": {},\n \"unset\": \"\"\n },\n \"patch_identifiers\": {\n \"append\": {},\n \"unappend\": {}\n }\n },\n \"email\": \"\"\n },\n \"id\": \"\"\n }\n },\n \"enablement_status\": \"AUTHORIZED\",\n \"background\": \"AVAILABLE\",\n \"device_metadata\": {\n \"device_id\": \"\",\n \"klaviyo_sdk\": \"flutter\",\n \"sdk_version\": \"\",\n \"device_model\": \"\",\n \"os_name\": \"tvos\",\n \"os_version\": \"\",\n \"manufacturer\": \"\",\n \"app_name\": \"\",\n \"app_version\": \"\",\n \"app_build\": \"\",\n \"app_id\": \"\",\n \"environment\": \"release\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/push-tokens?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "push-tokens" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-ab2729b3-01a5-488d-96dd-7bd497d5a9f3" }, { "id": "be2ad8e9-39e3-4da1-b79c-c09ff9613167", "name": "Client Error", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"push-token\",\n \"attributes\": {\n \"token\": \"\",\n \"platform\": \"ios\",\n \"vendor\": \"apns\",\n \"profile\": {\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"phone_number\": \"\",\n \"external_id\": \"\",\n \"_kx\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization\": \"\",\n \"locale\": \"\",\n \"title\": \"\",\n \"image\": \"\",\n \"location\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"region\": \"\",\n \"zip\": \"\",\n \"timezone\": \"\",\n \"ip\": \"\"\n },\n \"properties\": {},\n \"meta\": {\n \"patch_properties\": {\n \"append\": {},\n \"unappend\": {},\n \"unset\": \"\"\n },\n \"patch_identifiers\": {\n \"append\": {},\n \"unappend\": {}\n }\n },\n \"email\": \"\"\n },\n \"id\": \"\"\n }\n },\n \"enablement_status\": \"AUTHORIZED\",\n \"background\": \"AVAILABLE\",\n \"device_metadata\": {\n \"device_id\": \"\",\n \"klaviyo_sdk\": \"flutter\",\n \"sdk_version\": \"\",\n \"device_model\": \"\",\n \"os_name\": \"tvos\",\n \"os_version\": \"\",\n \"manufacturer\": \"\",\n \"app_name\": \"\",\n \"app_version\": \"\",\n \"app_build\": \"\",\n \"app_id\": \"\",\n \"environment\": \"release\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/push-tokens?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "push-tokens" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-be2ad8e9-39e3-4da1-b79c-c09ff9613167" }, { "id": "8dd64f3e-391c-4ad6-a7a4-5d6ebc6d31ab", "name": "Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"push-token\",\n \"attributes\": {\n \"token\": \"\",\n \"platform\": \"ios\",\n \"vendor\": \"apns\",\n \"profile\": {\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"phone_number\": \"\",\n \"external_id\": \"\",\n \"_kx\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization\": \"\",\n \"locale\": \"\",\n \"title\": \"\",\n \"image\": \"\",\n \"location\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"region\": \"\",\n \"zip\": \"\",\n \"timezone\": \"\",\n \"ip\": \"\"\n },\n \"properties\": {},\n \"meta\": {\n \"patch_properties\": {\n \"append\": {},\n \"unappend\": {},\n \"unset\": \"\"\n },\n \"patch_identifiers\": {\n \"append\": {},\n \"unappend\": {}\n }\n },\n \"email\": \"\"\n },\n \"id\": \"\"\n }\n },\n \"enablement_status\": \"AUTHORIZED\",\n \"background\": \"AVAILABLE\",\n \"device_metadata\": {\n \"device_id\": \"\",\n \"klaviyo_sdk\": \"flutter\",\n \"sdk_version\": \"\",\n \"device_model\": \"\",\n \"os_name\": \"tvos\",\n \"os_version\": \"\",\n \"manufacturer\": \"\",\n \"app_name\": \"\",\n \"app_version\": \"\",\n \"app_build\": \"\",\n \"app_id\": \"\",\n \"environment\": \"release\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/push-tokens?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "push-tokens" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-8dd64f3e-391c-4ad6-a7a4-5d6ebc6d31ab" } ], "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-425f08cb-43ae-4632-822d-1cc002b8adae" } ], "id": "a8c94bfe-2e38-4ead-a68f-70738ddc8f73", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-a8c94bfe-2e38-4ead-a68f-70738ddc8f73" }, { "name": "push-token-unregister", "item": [ { "name": "Unregister Client Push Token", "id": "7af4f8f3-6054-4f7e-ad9a-6bab9868e9d4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"push-token-unregister\",\n \"attributes\": {\n \"token\": \"\",\n \"platform\": \"ios\",\n \"profile\": {\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"external_id\": \"\",\n \"_kx\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization\": \"\",\n \"locale\": \"\",\n \"title\": \"\",\n \"image\": \"\",\n \"location\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"region\": \"\",\n \"zip\": \"\",\n \"timezone\": \"\",\n \"ip\": \"\"\n },\n \"properties\": {}\n },\n \"id\": \"\",\n \"meta\": {\n \"patch_properties\": {\n \"append\": {},\n \"unappend\": {},\n \"unset\": \"\"\n },\n \"patch_identifiers\": {\n \"append\": {},\n \"unappend\": {}\n }\n }\n }\n },\n \"vendor\": \"apns\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/push-token-unregister?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "push-token-unregister" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] }, "description": "Unregister a push token.\n\nThis endpoint is specifically designed to be called from our mobile SDKs ([iOS](https://github.com/klaviyo/klaviyo-swift-sdk) and [Android](https://github.com/klaviyo/klaviyo-android-sdk)) and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\nYou must have push notifications enabled to use this endpoint.

*Rate limits*:
Burst: `10/s`
Steady: `150/m`" }, "response": [ { "id": "7df68915-1034-4ff9-927c-da80422deee6", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"push-token-unregister\",\n \"attributes\": {\n \"token\": \"\",\n \"platform\": \"ios\",\n \"profile\": {\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"external_id\": \"\",\n \"_kx\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization\": \"\",\n \"locale\": \"\",\n \"title\": \"\",\n \"image\": \"\",\n \"location\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"region\": \"\",\n \"zip\": \"\",\n \"timezone\": \"\",\n \"ip\": \"\"\n },\n \"properties\": {}\n },\n \"id\": \"\",\n \"meta\": {\n \"patch_properties\": {\n \"append\": {},\n \"unappend\": {},\n \"unset\": \"\"\n },\n \"patch_identifiers\": {\n \"append\": {},\n \"unappend\": {}\n }\n }\n }\n },\n \"vendor\": \"apns\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/push-token-unregister?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "push-token-unregister" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-7df68915-1034-4ff9-927c-da80422deee6" }, { "id": "3e49565c-73b5-4d27-bb65-79889a4ce704", "name": "Client Error", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"push-token-unregister\",\n \"attributes\": {\n \"token\": \"\",\n \"platform\": \"ios\",\n \"profile\": {\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"external_id\": \"\",\n \"_kx\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization\": \"\",\n \"locale\": \"\",\n \"title\": \"\",\n \"image\": \"\",\n \"location\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"region\": \"\",\n \"zip\": \"\",\n \"timezone\": \"\",\n \"ip\": \"\"\n },\n \"properties\": {}\n },\n \"id\": \"\",\n \"meta\": {\n \"patch_properties\": {\n \"append\": {},\n \"unappend\": {},\n \"unset\": \"\"\n },\n \"patch_identifiers\": {\n \"append\": {},\n \"unappend\": {}\n }\n }\n }\n },\n \"vendor\": \"apns\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/push-token-unregister?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "push-token-unregister" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-3e49565c-73b5-4d27-bb65-79889a4ce704" }, { "id": "e4b94278-8a87-46b3-bab9-c930e88c9f35", "name": "Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"push-token-unregister\",\n \"attributes\": {\n \"token\": \"\",\n \"platform\": \"ios\",\n \"profile\": {\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"external_id\": \"\",\n \"_kx\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization\": \"\",\n \"locale\": \"\",\n \"title\": \"\",\n \"image\": \"\",\n \"location\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"region\": \"\",\n \"zip\": \"\",\n \"timezone\": \"\",\n \"ip\": \"\"\n },\n \"properties\": {}\n },\n \"id\": \"\",\n \"meta\": {\n \"patch_properties\": {\n \"append\": {},\n \"unappend\": {},\n \"unset\": \"\"\n },\n \"patch_identifiers\": {\n \"append\": {},\n \"unappend\": {}\n }\n }\n }\n },\n \"vendor\": \"apns\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/push-token-unregister?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "push-token-unregister" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-e4b94278-8a87-46b3-bab9-c930e88c9f35" } ], "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-7af4f8f3-6054-4f7e-ad9a-6bab9868e9d4" } ], "id": "73e56634-4eca-4947-85d1-0fbfb86f9a17", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-73e56634-4eca-4947-85d1-0fbfb86f9a17" }, { "name": "events", "item": [ { "name": "Create Client Event", "id": "5b1cf16a-d11a-4c00-9c21-f0809ab0f1be", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"event\",\n \"attributes\": {\n \"properties\": {},\n \"metric\": {\n \"data\": {\n \"type\": \"metric\",\n \"attributes\": {\n \"name\": \"\",\n \"service\": \"\"\n }\n }\n },\n \"profile\": {\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"external_id\": \"\",\n \"anonymous_id\": \"\",\n \"_kx\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization\": \"\",\n \"locale\": \"\",\n \"title\": \"\",\n \"image\": \"\",\n \"location\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"region\": \"\",\n \"zip\": \"\",\n \"timezone\": \"\",\n \"ip\": \"\"\n },\n \"properties\": {},\n \"meta\": {\n \"patch_properties\": {\n \"append\": {},\n \"unappend\": {},\n \"unset\": \"\"\n },\n \"patch_identifiers\": {\n \"append\": {},\n \"unappend\": {}\n }\n }\n },\n \"id\": \"\"\n }\n },\n \"time\": \"\",\n \"value\": \"\",\n \"value_currency\": \"\",\n \"unique_id\": \"\",\n \"backfill\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/events?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "events" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] }, "description": "Create a new event to track a profile's activity.\n\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\n\nDo not use this endpoint from server-side applications.\nTo create events from server-side applications, instead use [POST /api/events](https://developers.klaviyo.com/en/reference/create_event).\n\nNote that to update a profile's existing identifiers (e.g., email), you must use a server-side endpoint authenticated by a private API key. Attempts to do so via client-side endpoints will return a 202, however the identifier field(s) will not be updated.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`events:write`" }, "response": [ { "id": "2e5cd416-c33e-40ae-a3ad-91705c7659a2", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"event\",\n \"attributes\": {\n \"properties\": {},\n \"metric\": {\n \"data\": {\n \"type\": \"metric\",\n \"attributes\": {\n \"name\": \"\",\n \"service\": \"\"\n }\n }\n },\n \"profile\": {\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"external_id\": \"\",\n \"anonymous_id\": \"\",\n \"_kx\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization\": \"\",\n \"locale\": \"\",\n \"title\": \"\",\n \"image\": \"\",\n \"location\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"region\": \"\",\n \"zip\": \"\",\n \"timezone\": \"\",\n \"ip\": \"\"\n },\n \"properties\": {},\n \"meta\": {\n \"patch_properties\": {\n \"append\": {},\n \"unappend\": {},\n \"unset\": \"\"\n },\n \"patch_identifiers\": {\n \"append\": {},\n \"unappend\": {}\n }\n }\n },\n \"id\": \"\"\n }\n },\n \"time\": \"\",\n \"value\": \"\",\n \"value_currency\": \"\",\n \"unique_id\": \"\",\n \"backfill\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/events?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "events" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-2e5cd416-c33e-40ae-a3ad-91705c7659a2" }, { "id": "9c4c2e2c-3d50-46d4-9e21-3350dbb501a6", "name": "Client Error", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"event\",\n \"attributes\": {\n \"properties\": {},\n \"metric\": {\n \"data\": {\n \"type\": \"metric\",\n \"attributes\": {\n \"name\": \"\",\n \"service\": \"\"\n }\n }\n },\n \"profile\": {\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"external_id\": \"\",\n \"anonymous_id\": \"\",\n \"_kx\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization\": \"\",\n \"locale\": \"\",\n \"title\": \"\",\n \"image\": \"\",\n \"location\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"region\": \"\",\n \"zip\": \"\",\n \"timezone\": \"\",\n \"ip\": \"\"\n },\n \"properties\": {},\n \"meta\": {\n \"patch_properties\": {\n \"append\": {},\n \"unappend\": {},\n \"unset\": \"\"\n },\n \"patch_identifiers\": {\n \"append\": {},\n \"unappend\": {}\n }\n }\n },\n \"id\": \"\"\n }\n },\n \"time\": \"\",\n \"value\": \"\",\n \"value_currency\": \"\",\n \"unique_id\": \"\",\n \"backfill\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/events?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "events" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-9c4c2e2c-3d50-46d4-9e21-3350dbb501a6" }, { "id": "53de37b0-c878-4789-8e45-efd85e85d31d", "name": "Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"event\",\n \"attributes\": {\n \"properties\": {},\n \"metric\": {\n \"data\": {\n \"type\": \"metric\",\n \"attributes\": {\n \"name\": \"\",\n \"service\": \"\"\n }\n }\n },\n \"profile\": {\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"external_id\": \"\",\n \"anonymous_id\": \"\",\n \"_kx\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization\": \"\",\n \"locale\": \"\",\n \"title\": \"\",\n \"image\": \"\",\n \"location\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"region\": \"\",\n \"zip\": \"\",\n \"timezone\": \"\",\n \"ip\": \"\"\n },\n \"properties\": {},\n \"meta\": {\n \"patch_properties\": {\n \"append\": {},\n \"unappend\": {},\n \"unset\": \"\"\n },\n \"patch_identifiers\": {\n \"append\": {},\n \"unappend\": {}\n }\n }\n },\n \"id\": \"\"\n }\n },\n \"time\": \"\",\n \"value\": \"\",\n \"value_currency\": \"\",\n \"unique_id\": \"\",\n \"backfill\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/events?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "events" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-53de37b0-c878-4789-8e45-efd85e85d31d" } ], "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-5b1cf16a-d11a-4c00-9c21-f0809ab0f1be" } ], "id": "59e01497-6285-4bff-a7a1-e24b551c53be", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-59e01497-6285-4bff-a7a1-e24b551c53be" }, { "name": "profiles", "item": [ { "name": "Create or Update Client Profile", "id": "8da8d9d5-9a51-426f-83ec-7076139f8bef", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"external_id\": \"\",\n \"anonymous_id\": \"\",\n \"_kx\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization\": \"\",\n \"locale\": \"\",\n \"title\": \"\",\n \"image\": \"\",\n \"location\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"region\": \"\",\n \"zip\": \"\",\n \"timezone\": \"\",\n \"ip\": \"\"\n },\n \"properties\": {}\n },\n \"id\": \"\",\n \"meta\": {\n \"patch_properties\": {\n \"append\": {},\n \"unappend\": {},\n \"unset\": \"\"\n },\n \"patch_identifiers\": {\n \"append\": {},\n \"unappend\": {}\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/profiles?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "profiles" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] }, "description": "Create or update properties about a profile without tracking an associated event.\n\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\n\nDo not use this endpoint from server-side applications.\nTo create or update profiles from server-side applications, instead use [POST /api/profile-import](https://developers.klaviyo.com/en/reference/create_or_update_profile).\n\nNote that to update a profile's existing identifiers (e.g., email), you must use a server-side endpoint authenticated by a private API key. Attempts to do so via client-side endpoints will return a 202, however the identifier field(s) will not be updated.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`profiles:write`" }, "response": [ { "id": "85a48650-dfe2-469d-ad67-654328745102", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"external_id\": \"\",\n \"anonymous_id\": \"\",\n \"_kx\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization\": \"\",\n \"locale\": \"\",\n \"title\": \"\",\n \"image\": \"\",\n \"location\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"region\": \"\",\n \"zip\": \"\",\n \"timezone\": \"\",\n \"ip\": \"\"\n },\n \"properties\": {}\n },\n \"id\": \"\",\n \"meta\": {\n \"patch_properties\": {\n \"append\": {},\n \"unappend\": {},\n \"unset\": \"\"\n },\n \"patch_identifiers\": {\n \"append\": {},\n \"unappend\": {}\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/profiles?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "profiles" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-85a48650-dfe2-469d-ad67-654328745102" }, { "id": "220ae6ff-087e-40a5-9788-183539754a67", "name": "Client Error", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"external_id\": \"\",\n \"anonymous_id\": \"\",\n \"_kx\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization\": \"\",\n \"locale\": \"\",\n \"title\": \"\",\n \"image\": \"\",\n \"location\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"region\": \"\",\n \"zip\": \"\",\n \"timezone\": \"\",\n \"ip\": \"\"\n },\n \"properties\": {}\n },\n \"id\": \"\",\n \"meta\": {\n \"patch_properties\": {\n \"append\": {},\n \"unappend\": {},\n \"unset\": \"\"\n },\n \"patch_identifiers\": {\n \"append\": {},\n \"unappend\": {}\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/profiles?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "profiles" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-220ae6ff-087e-40a5-9788-183539754a67" }, { "id": "3a3d7584-f01b-467e-9b8e-62b5b688ded8", "name": "Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"external_id\": \"\",\n \"anonymous_id\": \"\",\n \"_kx\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization\": \"\",\n \"locale\": \"\",\n \"title\": \"\",\n \"image\": \"\",\n \"location\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"region\": \"\",\n \"zip\": \"\",\n \"timezone\": \"\",\n \"ip\": \"\"\n },\n \"properties\": {}\n },\n \"id\": \"\",\n \"meta\": {\n \"patch_properties\": {\n \"append\": {},\n \"unappend\": {},\n \"unset\": \"\"\n },\n \"patch_identifiers\": {\n \"append\": {},\n \"unappend\": {}\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/profiles?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "profiles" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-3a3d7584-f01b-467e-9b8e-62b5b688ded8" } ], "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-8da8d9d5-9a51-426f-83ec-7076139f8bef" } ], "id": "b94bbd82-5e30-480b-87ee-70d199d18fc3", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-b94bbd82-5e30-480b-87ee-70d199d18fc3" }, { "name": "event-bulk-create", "item": [ { "name": "Bulk Create Client Events", "id": "1d360f44-d8a5-4259-abd4-3743e2ae67f5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"event-bulk-create\",\n \"attributes\": {\n \"profile\": {\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"external_id\": \"\",\n \"anonymous_id\": \"\",\n \"_kx\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization\": \"\",\n \"locale\": \"\",\n \"title\": \"\",\n \"image\": \"\",\n \"location\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"region\": \"\",\n \"zip\": \"\",\n \"timezone\": \"\",\n \"ip\": \"\"\n },\n \"properties\": {}\n },\n \"id\": \"\",\n \"meta\": {\n \"patch_properties\": {\n \"append\": {},\n \"unappend\": {},\n \"unset\": \"\"\n },\n \"patch_identifiers\": {\n \"append\": {},\n \"unappend\": {}\n }\n }\n }\n },\n \"events\": {\n \"data\": [\n {\n \"type\": \"event\",\n \"attributes\": {\n \"properties\": {},\n \"metric\": {\n \"data\": {\n \"type\": \"metric\",\n \"attributes\": {\n \"name\": \"\",\n \"service\": \"\"\n }\n }\n },\n \"time\": \"\",\n \"value\": \"\",\n \"value_currency\": \"\",\n \"backfill\": false,\n \"unique_id\": \"\"\n }\n },\n {\n \"type\": \"event\",\n \"attributes\": {\n \"properties\": {},\n \"metric\": {\n \"data\": {\n \"type\": \"metric\",\n \"attributes\": {\n \"name\": \"\",\n \"service\": \"\"\n }\n }\n },\n \"time\": \"\",\n \"value\": \"\",\n \"value_currency\": \"\",\n \"backfill\": false,\n \"unique_id\": \"\"\n }\n }\n ]\n },\n \"backfill\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/event-bulk-create?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "event-bulk-create" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] }, "description": "Create new events to track a profile's activity.\n\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\n\nDo not use this endpoint from server-side applications.\nTo create events from server-side applications, instead use [POST /api/event-bulk-create-jobs](https://developers.klaviyo.com/en/reference/bulk_create_events).\n\nAccepts a maximum of `1000` events per request.

*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`events:write`" }, "response": [ { "id": "3b479648-d797-42be-b4af-3e503d5e7046", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"event-bulk-create\",\n \"attributes\": {\n \"profile\": {\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"external_id\": \"\",\n \"anonymous_id\": \"\",\n \"_kx\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization\": \"\",\n \"locale\": \"\",\n \"title\": \"\",\n \"image\": \"\",\n \"location\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"region\": \"\",\n \"zip\": \"\",\n \"timezone\": \"\",\n \"ip\": \"\"\n },\n \"properties\": {}\n },\n \"id\": \"\",\n \"meta\": {\n \"patch_properties\": {\n \"append\": {},\n \"unappend\": {},\n \"unset\": \"\"\n },\n \"patch_identifiers\": {\n \"append\": {},\n \"unappend\": {}\n }\n }\n }\n },\n \"events\": {\n \"data\": [\n {\n \"type\": \"event\",\n \"attributes\": {\n \"properties\": {},\n \"metric\": {\n \"data\": {\n \"type\": \"metric\",\n \"attributes\": {\n \"name\": \"\",\n \"service\": \"\"\n }\n }\n },\n \"time\": \"\",\n \"value\": \"\",\n \"value_currency\": \"\",\n \"backfill\": false,\n \"unique_id\": \"\"\n }\n },\n {\n \"type\": \"event\",\n \"attributes\": {\n \"properties\": {},\n \"metric\": {\n \"data\": {\n \"type\": \"metric\",\n \"attributes\": {\n \"name\": \"\",\n \"service\": \"\"\n }\n }\n },\n \"time\": \"\",\n \"value\": \"\",\n \"value_currency\": \"\",\n \"backfill\": false,\n \"unique_id\": \"\"\n }\n }\n ]\n },\n \"backfill\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/event-bulk-create?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "event-bulk-create" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-3b479648-d797-42be-b4af-3e503d5e7046" }, { "id": "2b59a66b-b9db-4ed1-baad-70cb3ed73217", "name": "Client Error", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"event-bulk-create\",\n \"attributes\": {\n \"profile\": {\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"external_id\": \"\",\n \"anonymous_id\": \"\",\n \"_kx\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization\": \"\",\n \"locale\": \"\",\n \"title\": \"\",\n \"image\": \"\",\n \"location\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"region\": \"\",\n \"zip\": \"\",\n \"timezone\": \"\",\n \"ip\": \"\"\n },\n \"properties\": {}\n },\n \"id\": \"\",\n \"meta\": {\n \"patch_properties\": {\n \"append\": {},\n \"unappend\": {},\n \"unset\": \"\"\n },\n \"patch_identifiers\": {\n \"append\": {},\n \"unappend\": {}\n }\n }\n }\n },\n \"events\": {\n \"data\": [\n {\n \"type\": \"event\",\n \"attributes\": {\n \"properties\": {},\n \"metric\": {\n \"data\": {\n \"type\": \"metric\",\n \"attributes\": {\n \"name\": \"\",\n \"service\": \"\"\n }\n }\n },\n \"time\": \"\",\n \"value\": \"\",\n \"value_currency\": \"\",\n \"backfill\": false,\n \"unique_id\": \"\"\n }\n },\n {\n \"type\": \"event\",\n \"attributes\": {\n \"properties\": {},\n \"metric\": {\n \"data\": {\n \"type\": \"metric\",\n \"attributes\": {\n \"name\": \"\",\n \"service\": \"\"\n }\n }\n },\n \"time\": \"\",\n \"value\": \"\",\n \"value_currency\": \"\",\n \"backfill\": false,\n \"unique_id\": \"\"\n }\n }\n ]\n },\n \"backfill\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/event-bulk-create?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "event-bulk-create" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-2b59a66b-b9db-4ed1-baad-70cb3ed73217" }, { "id": "f426ed8a-156a-4fa7-9e11-0494fb980d5e", "name": "Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"event-bulk-create\",\n \"attributes\": {\n \"profile\": {\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"external_id\": \"\",\n \"anonymous_id\": \"\",\n \"_kx\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"organization\": \"\",\n \"locale\": \"\",\n \"title\": \"\",\n \"image\": \"\",\n \"location\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"region\": \"\",\n \"zip\": \"\",\n \"timezone\": \"\",\n \"ip\": \"\"\n },\n \"properties\": {}\n },\n \"id\": \"\",\n \"meta\": {\n \"patch_properties\": {\n \"append\": {},\n \"unappend\": {},\n \"unset\": \"\"\n },\n \"patch_identifiers\": {\n \"append\": {},\n \"unappend\": {}\n }\n }\n }\n },\n \"events\": {\n \"data\": [\n {\n \"type\": \"event\",\n \"attributes\": {\n \"properties\": {},\n \"metric\": {\n \"data\": {\n \"type\": \"metric\",\n \"attributes\": {\n \"name\": \"\",\n \"service\": \"\"\n }\n }\n },\n \"time\": \"\",\n \"value\": \"\",\n \"value_currency\": \"\",\n \"backfill\": false,\n \"unique_id\": \"\"\n }\n },\n {\n \"type\": \"event\",\n \"attributes\": {\n \"properties\": {},\n \"metric\": {\n \"data\": {\n \"type\": \"metric\",\n \"attributes\": {\n \"name\": \"\",\n \"service\": \"\"\n }\n }\n },\n \"time\": \"\",\n \"value\": \"\",\n \"value_currency\": \"\",\n \"backfill\": false,\n \"unique_id\": \"\"\n }\n }\n ]\n },\n \"backfill\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/event-bulk-create?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "event-bulk-create" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-f426ed8a-156a-4fa7-9e11-0494fb980d5e" } ], "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-1d360f44-d8a5-4259-abd4-3743e2ae67f5" } ], "id": "26e265ae-d16a-4fa5-ae96-10ce4f91af31", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-26e265ae-d16a-4fa5-ae96-10ce4f91af31" }, { "name": "back-in-stock-subscriptions", "item": [ { "name": "Create Client Back In Stock Subscription", "id": "14cb42b4-435f-465e-8121-ccccfbc1749d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"back-in-stock-subscription\",\n \"attributes\": {\n \"channels\": [\n \"WHATSAPP\",\n \"PUSH\"\n ],\n \"profile\": {\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"external_id\": \"\"\n },\n \"id\": \"\"\n }\n }\n },\n \"relationships\": {\n \"variant\": {\n \"data\": {\n \"type\": \"catalog-variant\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/back-in-stock-subscriptions?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "back-in-stock-subscriptions" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] }, "description": "Subscribe a profile to receive back in stock notifications. Check out [our Back in Stock API guide](https://developers.klaviyo.com/en/docs/how_to_set_up_custom_back_in_stock) for more details.\n\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\n\nDo not use this endpoint from server-side applications.\nTo create back in stock subscriptions from server-side applications, instead use [POST /api/back-in-stock-subscriptions](https://developers.klaviyo.com/en/reference/create_back_in_stock_subscription).

*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:write`\n`profiles:write`" }, "response": [ { "id": "198e362d-baae-48dd-80f2-4d08aec3c55e", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"back-in-stock-subscription\",\n \"attributes\": {\n \"channels\": [\n \"WHATSAPP\",\n \"PUSH\"\n ],\n \"profile\": {\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"external_id\": \"\"\n },\n \"id\": \"\"\n }\n }\n },\n \"relationships\": {\n \"variant\": {\n \"data\": {\n \"type\": \"catalog-variant\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/back-in-stock-subscriptions?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "back-in-stock-subscriptions" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-198e362d-baae-48dd-80f2-4d08aec3c55e" }, { "id": "28f81275-9402-44cb-98bd-c2b2dfcc4fee", "name": "Client Error", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"back-in-stock-subscription\",\n \"attributes\": {\n \"channels\": [\n \"WHATSAPP\",\n \"PUSH\"\n ],\n \"profile\": {\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"external_id\": \"\"\n },\n \"id\": \"\"\n }\n }\n },\n \"relationships\": {\n \"variant\": {\n \"data\": {\n \"type\": \"catalog-variant\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/back-in-stock-subscriptions?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "back-in-stock-subscriptions" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-28f81275-9402-44cb-98bd-c2b2dfcc4fee" }, { "id": "a6f2f086-9246-4be2-a9ba-16e7c1452223", "name": "Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"back-in-stock-subscription\",\n \"attributes\": {\n \"channels\": [\n \"WHATSAPP\",\n \"PUSH\"\n ],\n \"profile\": {\n \"data\": {\n \"type\": \"profile\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"external_id\": \"\"\n },\n \"id\": \"\"\n }\n }\n },\n \"relationships\": {\n \"variant\": {\n \"data\": {\n \"type\": \"catalog-variant\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/client/back-in-stock-subscriptions?company_id=", "host": [ "{{baseUrl}}" ], "path": [ "client", "back-in-stock-subscriptions" ], "query": [ { "description": "(Required) Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.", "key": "company_id", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-a6f2f086-9246-4be2-a9ba-16e7c1452223" } ], "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-14cb42b4-435f-465e-8121-ccccfbc1749d" } ], "id": "84a447ee-4187-4b61-8aaa-421c8c4b4227", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-84a447ee-4187-4b61-8aaa-421c8c4b4227" } ], "id": "2a56df18-98d0-4a25-a914-99e222e430c9", "createdAt": "2026-07-28T02:00:35.000Z", "updatedAt": "2026-07-28T02:00:35.000Z", "uid": "35240-2a56df18-98d0-4a25-a914-99e222e430c9" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://a.klaviyo.com" } ] }