Raw schema
{
"type": "object",
"properties": {
"deal_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Pipeline CRM deal id."
},
"name": {
"description": "New deal name.",
"type": "string",
"minLength": 1,
"maxLength": 255
},
"summary": {
"description": "New description.",
"type": "string",
"maxLength": 5000
},
"owner_id": {
"description": "New owner user id.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"stage_id": {
"description": "Move the deal to this deal stage id.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"status_id": {
"description": "Deal status id.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"value": {
"description": "New value.",
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"pattern": "^-?\\d{1,15}(\\.\\d{1,4})?$"
}
]
},
"expected_close_date": {
"description": "New expected close date (yyyy-mm-dd).",
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$"
},
"closed_time": {
"description": "Actual close date (yyyy-mm-dd).",
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$"
},
"probability": {
"description": "Probability of closing, 0-100. 100 closes the deal as won, 0 as lost.",
"type": "integer",
"minimum": 0,
"maximum": 100
},
"company_id": {
"description": "Company id.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"primary_contact_id": {
"description": "Primary contact person id.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"person_ids": {
"description": "Full list of associated person ids (replaces the list).",
"maxItems": 100,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"loss_reason_id": {
"description": "Deal loss reason id.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"loss_reason_notes": {
"description": "Why the deal was lost.",
"type": "string",
"maxLength": 5000
},
"won_reason_id": {
"description": "Deal won reason id.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"won_reason_notes": {
"description": "Why the deal was won.",
"type": "string",
"maxLength": 5000
},
"archived": {
"description": "true archives the deal, false restores it.",
"type": "boolean"
},
"tag_ids": {
"description": "Full list of deal tag ids (replaces the list).",
"maxItems": 100,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"custom_fields": {
"description": "Custom field values keyed by the custom field's key (see the account's custom field labels in Pipeline CRM).",
"type": "object",
"propertyNames": {
"type": "string",
"pattern": "^[A-Za-z0-9_]{1,80}$"
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"maxItems": 100,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
}
]
}
}
]
}
}
},
"required": [
"deal_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}