Skip to main content
POST
Create a CRM pipeline

Authorizations

Authorization
string
header
required

Runtime context-key (rctx_*) issued by the Ravi gateway. Required for every non-open scope. Bootstrap the first key with ravi daemon init-admin-key; rotate, derive, and revoke via the ravi context family. Specs: runtime/context-keys, sdk/auth.

Body

application/json
name
string
required

Pipeline name

analystAvoid
string

Comma list of forbidden topics

analystMentions
string

Comma list of mandatory mentions in analyst messages

analystTone
string

Tone for analyst-drafted messages

consumer
string

Comma list of consumer agent ids

default
boolean

Mark as default pipeline for the entity type

entityType
string

CRM entity type (default: opportunity)

hitlRequiredWhen
string

JSON {conditions:[...]}

idempotencyKey
string

Deduplicate repeated create attempts

messagePrefix
string

Outbound message prefix

messageSuffix
string

Outbound message suffix

metadata
string

Raw metadata JSON object (structured flags merge on top)

objetivo
string

One-paragraph pipeline purpose

priorityGlobal
string

Cross-pipeline arbitration priority (1=highest, 5=lowest)

producer
string

Comma list of producer agent ids

readingListId
string

Reading list slug bound to this pipeline

reguaTag
string[]

Repeatable regua tag JSON {tag,apply_when,linked_stage,apply_by}

Comma list of related CRON ids

Comma list of related trigger ids

sendWindow
string

Send window 'hours[,days],timezone' (e.g. 9-21,mon-sat,America/Sao_Paulo)

versao
string

Semver of this metadata document

vipGuardAction
string

hitl | block | tag_only

vipGuardLtv
string

Lifetime value threshold for VIP

vipGuardTag
string

Comma list of VIP tag triggers

Response

Success — body conforms to the @Returns schema.

changedCount
number
required
status
string
required
{key}
any