Skip to main content
POST
Create a persona

Authorizations

Authorization
string
header
required

Workspace API key from the Avina dashboard (Settings → API keys).

Headers

Idempotency-Key
string

Any unique string. Retrying with the same key returns the first response instead of repeating the action.

Maximum string length: 255

Body

application/json
job_titles
string[]
required
Minimum array length: 1
name
string | null
Maximum string length: 191
contacts_per_company
integer
default:1
Required range: 1 <= x <= 100
enrich_emails
boolean
default:true
enrich_phones
boolean
default:false

Phone enrichment costs extra credits.

contact_countries
string[] | null

Countries where the contacts are located (ISO 3166-1 alpha-2), not the company headquarters. null or [] = worldwide.

Pattern: ^[A-Za-z]{2}$
Example:

Response

The created persona.

object
string
required
Allowed value: "persona"
id
string<uuid>
required
job_titles
string[]
required
contacts_per_company
integer
required
enrich_emails
boolean
required
enrich_phones
boolean
required
contact_countries
string[] | null
required

Countries where the contacts are located, uppercase; null or [] = worldwide.

created_at
string<date-time>
required
updated_at
string<date-time>
required
name
string | null