Sign in
campaigns

Get Campaign Brief

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

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

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

Changed in 3 of the 23 revisions of this API.4

  • 216c8523b7ae1See the full diff
    • ○

      added the required property / to the response with the status

      response-required-property-added

  • c14a8fc770d02See the full diff
    • ○

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

      response-optional-property-added

    • ○

      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

      response-property-default-value-changed

  • 0d7ad1d56e7d1See the full diff
    • ○

      endpoint added

      endpoint-added