Open a deal

Before you call

Credential

Authorization: Bearer $KEY

Scope

contacts:write

Graphql

Mutation.contactsDealCreate

Sdk

contacts.deal.create

Cli

contacts deal create

Request bodyapplication/json, required

• namestringrequired
  At most 200 characters.
• pipelineIdstring (uuid)required
• stagestring
  Pattern: ^[a-z][a-z0-9_]{0,39}$.
• amountMinorinteger
  At least 0. At most 1000000000000.
• currencystring
  At most 3 characters.
• contactIdstring (uuid) or null
• companyIdstring (uuid) or null
• ownerstring or null
• closeDatestring or null
• customobject

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