Preview an AI-written step

POST

/campaigns/{id}/sequence/preview

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

idstringrequired

Campaign id.

Body

application/json

kindenum<string>required

Available options: message

briefstringrequired

The step's brief: what Bavlio should write, in the sender's words.

Required string length: 1 - 1000

after_lead_idstring

The lead the previous preview was written for. Bavlio writes the next preview for the lead after it, so the same brief can be tried on someone else.

Response

application/json

StepPreview

leadobjectrequired

The campaign lead the preview was written for.

textstringrequired

The message or email body Bavlio wrote for this lead from the brief.

Preview an AI-written step

curl --request POST \
  --url https://api.bavlio.com/campaigns/{id}/sequence/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "kind": "message",
  "brief": "<string>",
  "after_lead_id": "<string>"
}
'

curl --request POST \  --url https://api.bavlio.com/campaigns/{id}/sequence/preview \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{  "kind": "message",  "brief": "<string>",  "after_lead_id": "<string>"}'

{
  "lead": {
    "id": "<string>",
    "name": "<string>",
    "title": "<string>",
    "company": "<string>"
  },
  "text": "<string>"
}

{  "lead": {    "id": "<string>",    "name": "<string>",    "title": "<string>",    "company": "<string>"  },  "text": "<string>"}