POST
Create Persona

Authorizations

X-API-Key
string
header
required

An API key of your account, from Settings > API Keys. It starts with gnz-.

Headers

Idempotency-Key
string | null

Any unique string, such as a UUID. Send the same key again to get the first answer and not a second write. The API keeps an answer for 24 hours.

Path Parameters

brand_id
integer
required

Body

application/json
country
string
required

ISO 3166-1 alpha-2, such as US or RO.

Example:

"US"

description
string
required
Required string length: 1 - 5000
Example:

"A consultant who flies each week and works on the plane."

name
string
required
Required string length: 1 - 255
Example:

"Frequent flyer"

city
string | null
Maximum string length: 255
Example:

"Chicago"

properties
Properties · object

The sections that describe the persona.

Response

Successful Response

description
string
required
id
integer
required
name
string
required
city
string | null
country
string | null

ISO 3166-1 alpha-2, such as US or RO.

properties
Properties · object