Coaching

Edit a coaching scenario

Requires the coaching.write scope.

patch/coaching/scenarios/{id}

Request

  • Base URL: https://developer.solofire.com/v1
  • URL: https://developer.solofire.com/v1/coaching/scenarios/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Request body

namestring

Scenario title shown to reps.

descriptionstring

The briefing a rep reads before starting.

persona_idstring

A saved persona (see GET /v1/coaching/personas). Its role and description are copied in, and folder_ids / file_ids must stay within its reference content. Required unless persona_role is given.

persona_rolestring

A free-text persona role instead of persona_id. No reference-content restriction applies.

persona_descriptionstring

Free-text persona description (with persona_role).

persona_dispositionstring

green (friendly), yellow (neutral, default) or red (hostile).

modestring

sell (the AI buys, default) or buy (the AI sells to the rep).

scenariostring

cold_call, discovery (default), pricing, objection or save.

difficultystring

shadow, standard (default) or interruption.

industry_contextstring

Industry or account context for the conversation.

product_linestring

Product line the session is about; drives retrieval.

languagestring

Language tag such as en-US (default), es-MX, pt-BR.

deliverystring

voice (default) or avatar.

live_avatar_idstring

Avatar pinned for avatar delivery; omit to let the rep choose.

approved_content_onlyboolean

Treat the reference content as the only source of truth: the persona challenges unsupported product claims, the rep is flagged live and the scorecard marks them unverified. Default false.

reminder_frequency_daysinteger

Reminder cadence for assignees who have not practised: 3, 7 (default), 14 or 30.

max_remindersinteger

Reminder cap, 0 to 10. Default 4.

Response

Success

object required

Changes

No recorded changes to this operation across all 1 revision of this API.