HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Create Agent Secret

🚧

This endpoint is in beta and subject to change.

A beta revision header (2026-04-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 a secret for use by one or more Customer Agent tools.

The provided plaintext value is encrypted before persistence
and is never exposed after creation. Subsequent responses return
only the mask (last 3 characters) and non-sensitive
metadata. Secret names are trimmed of leading and trailing
whitespace before validation, and both the resulting name
and provided value must be non-empty. If another secret
already exists with the same name for the calling company, the
API returns 409 Conflict.

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

Scopes:
agents:write

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

Request to create an Agent Secret for use by Customer Agent tools.

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

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

Responses

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