Skip to main content
POST
Create Persona

Authorizations

Authorization
string
header
required

Team API key created in Team Settings. Use it with URLs for the same team.

Path Parameters

project
string<uuid>
required

Project UUID.

Body

application/json

name and at least one job title are required. After a save, Surfacd writes the persona's perspective from its profile and adds it when its prompts are asked.

name
string
required

Must be unique within the project (case-insensitive).

Required string length: 1 - 100
job_titles
string[]
required

Job titles the persona typically holds. At least one is required.

Required array length: 1 - 8 elements
Maximum string length: 100
seniorities
string[] | null

Seniority levels, e.g. Director. Any short label is accepted.

Maximum array length: 8
Maximum string length: 100
company_sizes
enum<string>[] | null

Employee-count bands of the companies the persona works at.

An employee-count band.

Available options:
1-10,
11-50,
51-200,
201-500,
501-1000,
1001-5000,
5001-10000,
10000+
industries
string[] | null

Industries the persona works in. Any short label is accepted.

Maximum array length: 8
Maximum string length: 100
motivators
string | null

What the persona is trying to achieve and why they look for a solution.

Maximum string length: 255
pain_points
string | null

What frustrates the persona today.

Maximum string length: 255

Response

Created persona.

uuid
string<uuid>
required
name
string
required

Short label shown in filters and reports. Unique within the project (case-insensitive).

job_titles
string[]
required

Job titles the persona typically holds.

Maximum string length: 100
seniorities
string[]
required

Seniority levels, e.g. Director. Any short label is accepted.

Maximum string length: 100
company_sizes
enum<string>[]
required

Employee-count bands of the companies the persona works at.

An employee-count band.

Available options:
1-10,
11-50,
51-200,
201-500,
501-1000,
1001-5000,
5001-10000,
10000+
industries
string[]
required

Industries the persona works in. Any short label is accepted.

Maximum string length: 100
motivators
string | null
required

What the persona is trying to achieve and why they look for a solution.

pain_points
string | null
required

What frustrates the persona today.

prompts_count
integer
required

Number of the project's prompts asked as this persona.

created_at
string<date-time>
required
updated_at
string<date-time>
required