campaigns

Get Campaign Brief

Changed on

The Message-step brief for this build, or null before the first exchange.

get/campaigns/audience-builds/{build_id}/brief

Request

Path parameters

build_idstring required

Response

Successful Response

idstring required
build_idstring required
campaign_idstring nullable
status'collecting' | 'ready' required
open_questionsstring[]
rendered_instructionsstring
updated_atstring nullable

Changes

    • info

      added the required property / to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      the response's property default value changed from {"summary":"","offers":[],"promotions":[],"sample_messages":[],"tone":"","must_say":[],"must_not_say":[],"handling_rules":[],"escalate_when":[],"facts":[]} to {"summary":"","offers":[],"promotions":[],"sample_messages":[],"tone":"","must_say":[],"must_not_say":[],"handling_rules":[],"escalate_when":[],"facts":[],"office_handles_booking":false} for the status