Draft a campaign from a brief

post/project-hub/campaign-from-brief

Draft a campaign from a brief: picks the segment among those that can be written to, reuses the best template (the organisation's if the project has none), writes the copy in the audience language and runs the check. It stops at a draft: a person approves it before anything is sent.

Before you call

Credential: Authorization: Bearer $KEY
Scope: workspace:write
Graphql: Mutation.workspaceProjectHubDraftFromBrief
Sdk: workspace.projectHub.draftFromBrief
Cli: workspace project hub draft from brief

Request bodyapplication/json, required

briefstringrequired
At most 2000 characters.
languagestring
At most 10 characters.
channelstring
One of: email, sms. Default: email.

Responses

200application/json
Success
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X POST 'https://api.rivier.ai/project-hub/campaign-from-brief' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "brief": "string"
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown