Create a deal
POST/crm/statuses/{statusId}/dealsRequest
Path Params
statusId
string
required
Body Params application/json
title
string | null
optional
<= 255 characters
amount
number <double> | null
optional
winStatus
enum<string> | enum<null>
optional
Allowed values:
wonlostarchived
description
string | null
optional
assignees
array[string <uuid>]
optional
organizations
array[string <uuid>]
optional
contacts
array[string <uuid>]
optional
tags
array[integer]
optional
customFields
object (Custom field values)
optional
A key-value object with custom field id as key and custom field value
For example
"customFields" : {
"<text_custom_field_id>": "Text value",
"<boolean_custom_field_id>": true,
"<datetime_custom_field_id>": "<ISO 8601 datetime string>",
"<select_custom_field_id>": "<custom_field_option_id>"
"<multiselect_custom_field_id>": ["<custom_field_option_id>"],
"<member_custom_field_id>": ["<user_id>"],
"<contact_custom_field_id>": "<contact_id>",
"<link_custom_field_id>": "https://example.com",
"<approval_custom_field_id>": ["<user_id>"]
}
Example
{
"title": "string",
"amount": 0,
"winStatus": "won",
"description": "string",
"assignees": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"organizations": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"contacts": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"tags": [
0
],
"customFields": {}
}Responses
Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
success
boolean
optional
deal
object (Deal)
optional
id
string
read-onlyoptional
String identifier unique only within this resource in the workspace.
creatorId
string <uuid>
read-onlyoptional
funnelId
string
read-onlyoptional
statusId
string
read-onlyoptional
assignees
array[string <uuid>]
optional
organizations
array[string <uuid>]
optional
contacts
array[string <uuid>]
optional
title
string | null
optional
description
string | null
optional
amount
number <double> | null
optional
winStatus
enum<string> | enum<null>
optional
Allowed values:
wonlostarchived
createdAt
string <date-time>
optional
updatedAt
string <date-time>
optional
tags
array[integer]
optional
tasks
array[object (Task) {29}]
optional
customFields
array[object (CustomFieldValue) {6}]
optional
attachments
array[object (Attachment) {7}]
optional
Example
Not configured
Last modified: a year ago