Skip to main content
PATCH
Patch Brand Audience Scenario

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brand_id
string<uuid>
required
scenario_id
string<uuid>
required

Body

application/json
expected_revision
integer
required
Required range: x >= 1
primary_persona_id
string<uuid> | null
scenario_name
string | null
Required string length: 1 - 160
scene
string | null
Required string length: 1 - 3000
trigger
string | null
Required string length: 1 - 2000
pain_points_frustrations
string[] | null
Maximum array length: 12
desired_outcome
string | null
Required string length: 1 - 2000
emotion_state
string | null
Required string length: 1 - 1000
current_alternatives
string[] | null
Maximum array length: 12
barrier
string | null
Required string length: 1 - 2000

Response

Successful Response

brand_id
string<uuid>
required
state
enum<string>
required
Available options:
not_started,
researching,
ready,
partial,
failed
subject_id
string<uuid> | null
revision
integer
default:0
business_model
enum<string> | null
Available options:
b2b,
b2c,
both
primary_surface
enum<string> | null
Available options:
ecommerce,
lead_generation,
mobile_app,
store,
awareness,
marketplace,
subscription
supporting_surfaces
enum<string>[]
Available options:
ecommerce,
lead_generation,
mobile_app,
store,
awareness,
marketplace,
subscription
icp
ICPDocument · object | null
personas
AudiencePersonaResponse · object[]
scenarios
ScenarioDocument · object[]
confidence
number | null
source_count
integer
default:0
Required range: x >= 0
website_sources
AudienceWebsiteSourceResponse · object[]
latest_run
AudienceRunResponse · object | null
updated_at
string<date-time> | null