HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Create Customer Agent

🚧

This endpoint is in beta and subject to change.

A beta revision header (2026-10-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our versioning and deprecation policy for more information.

Creates the Customer Agent for the calling company.

Returns 201 Created when the Customer Agent is created, and 200 OK with the existing Customer Agent when the account already has one. storefront_url is used only when the agent is first created; if omitted then, the URL of the account's Shopify integration, or else its contact-information URL, is used. Without a usable URL, the agent's knowledge base starts empty.

Rate limits:
Burst: 10/s
Steady: 150/m

Scopes:
agents:write

OpenAPI Spec

Query Params
fields[customer-agent]
array of strings
fields[customer-agent]
Body Params

JSON:API request for creating the customer-agent resource.

data
object
required
Headers
string
required
Defaults to 2026-10-15.pre

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/vnd.api+json