Rivier/ Reference/ contacts

Define a pipeline

post/crm/pipelines

Before you call

Credential
Authorization: Bearer $KEY
Scope
contacts:write
Graphql
Mutation.contactsPipelineCreate
Sdk
contacts.pipeline.create
Cli
contacts pipeline create

Request bodyapplication/json, required

  • namestringrequired
    At most 80 characters.
  • stageslist of objectrequired
    • idstringrequired
      Pattern: ^[a-z][a-z0-9_]{0,39}$.
    • namestringrequired
      At most 60 characters.
    • probabilitynumber
      At least 0. At most 100.
    • kindstring
      One of: open, won, lost.
  • currencystring
    At most 3 characters.

Responses

  • 201application/json
    Success

    object

  • 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