Skip to main content
POST
Set a CRM pipeline field (or patch metadata via structured flags)

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
field
string
required

name|entity-type|default|status|metadata

pipeline
string
required

CRM pipeline ID or name

value
string
required

New value (use '-' to patch metadata via structured flags)

analystAvoid
string

Patch metadata.analyst_guidance.avoid (comma)

analystMentions
string

Patch metadata.analyst_guidance.mandatory_mentions (comma)

analystTone
string

Patch metadata.analyst_guidance.tone

consumer
string

Patch metadata.consumers (comma list)

hitlRequiredWhen
string

Patch metadata.hitl_required_when

messagePrefix
string

Patch metadata.message_rule.prefix

messageSuffix
string

Patch metadata.message_rule.suffix

objetivo
string

Patch metadata.objetivo

priorityGlobal
string

Patch metadata.priority_global (1-5)

producer
string

Patch metadata.producers (comma list)

readingListId
string

Patch metadata.reading_list_id

reguaTag
string[]

Repeatable regua tag JSON (appends to existing list)

Patch metadata.related_crons (comma)

Patch metadata.related_triggers (comma)

sendWindow
string

Patch metadata.send_window

versao
string

Patch metadata.versao

vipGuardAction
string

Patch metadata.vip_guard.action (hitl|block|tag_only)

vipGuardLtv
string

Patch metadata.vip_guard.ltv_threshold

vipGuardTag
string

Patch metadata.vip_guard.tag_triggers

Response

Success — body conforms to the @Returns schema.

changedCount
number
required
status
string
required
{key}
any