Praecise Platform
Menu

Rivier/ Reference/ campaigns

Create a sequence

post/crm/sequences

Create a sequence: who it is for, a team member, and steps (email, text, WhatsApp, call) with the days to wait before each. The team member writes each message from the step's brief.

Before you call

Credential
Authorization: Bearer $KEY
Scope
campaigns:write
Graphql
Mutation.campaignsSequenceCreate
Sdk
campaigns.sequence.create
Cli
campaigns sequence create

Request bodyapplication/json, required

  • namestringrequired
    At most 160 characters.
  • agentIdstring
    At most 120 characters.
  • audiencestringrequired
    At most 300 characters.
  • purposestring
    Default: outreach. Pattern: ^[a-z][a-z0-9_]{0,29}$.
  • stepslist of objectrequired
  • windowobject
    Default: {"days":[1,2,3,4,5],"from":"09:00","to":"17:00"}.
    • dayslist of integer
      Default: [1,2,3,4,5].
    • fromstring
      Default: 09:00. Pattern: ^([01]\d|2[0-3]):[0-5]\d$.
    • tostring
      Default: 17:00. Pattern: ^([01]\d|2[0-3]):[0-5]\d$.
    • timezonestring
      At most 60 characters.
  • limitsobject
    Default: {"perDay":50,"perDomainPerDay":3}.
    • perDayinteger
      Default: 50. At least 1. At most 5000.
    • perDomainPerDayinteger
      Default: 3. At least 1. At most 500.
  • approvalstring
    One of: person, rule. Default: person.

Responses

  • 201application/json
    Success
    • idstring (uuid)required
    • statestring or nullrequired
    • dataobjectrequired
  • 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

This page as Markdown