Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://api.salesflare.com
/accounts
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | query | optional | array | |
| details | query | optional | boolean | |
| search | query | optional | string | |
| name | query | optional | string | |
| creation_after | query | optional | string | |
| creation_before | query | optional | string | |
| min_size | query | optional | number | |
| max_size | query | optional | number | |
| domain | query | optional | array | |
| tag | query | optional | array | |
| tag.name | query | optional | array | |
| address.country | query | optional | array | |
| address.city | query | optional | array | |
| address.state_region | query | optional | array | |
| hotness | query | optional | number | 1: Room temp, 2: Hot, 3: On fire |
| offset | query | optional | number | |
| custom | query | optional | string | |
| order_by | query | optional | array | Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. Defaults to asc. |
| q | query | optional | string | |
| limit | query | optional | number |
GET /accounts
/accounts/{account_id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| account_id | path | required | number |
GET /accounts/{account_id}
/accounts/{account_id}/messages
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| account_id | path | required | number | |
| before | query | optional | string | |
| after | query | optional | string | |
| limit | query | optional | number |
GET /accounts/{account_id}/messages
/contacts
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | query | optional | array | |
| name | query | optional | string | |
| query | optional | string | ||
| phone_number | query | optional | string | |
| domain | query | optional | string | |
| modification_after | query | optional | string | |
| modification_before | query | optional | string | |
| creation_after | query | optional | string | |
| creation_before | query | optional | string | |
| account | query | optional | array | |
| tag | query | optional | array | |
| tag.name | query | optional | array | |
| position.role | query | optional | array | |
| address.country | query | optional | array | |
| address.state_region | query | optional | array | |
| address.city | query | optional | array | |
| includeArchived | query | optional | boolean | |
| search | query | optional | string | |
| type | query | optional | string | |
| limit | query | optional | number | |
| offset | query | optional | number | |
| custom | query | optional | string | |
| order_by | query | optional | array | Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. Defaults to asc. |
| q | query | optional | string |
GET /contacts
/contacts/{contact_id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| contact_id | path | required | number |
GET /contacts/{contact_id}
/customfields/types
GET /customfields/types
/customfields/{itemClass}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| itemClass | path | required | string | |
| includeDisabled | query | optional | boolean | |
| pipeline | query | optional | number | |
| name | query | optional | string |
GET /customfields/{itemClass}
/customfields/{itemClass}/{customFieldApiField}/options
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| itemClass | path | required | string | |
| customFieldApiField | path | required | string | |
| searchString | query | optional | string |
GET /customfields/{itemClass}/{customFieldApiField}/options
/customfields/{itemClass}/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| itemClass | path | required | string | |
| id | path | required | number |
GET /customfields/{itemClass}/{id}
/datasources/email
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| includeTeamDataSources | query | optional | boolean | Team data sources will only be included when the session user is an admin. |
GET /datasources/email
/filterfields/{entity}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| entity | path | required | string | |
| pipeline | query | optional | number | |
| includePipelineSpecificPredefinedFilterFields | query | optional | boolean |
GET /filterfields/{entity}
/groups
GET /groups
/groups/{id}
GET /groups/{id}
/conferences/{conference_id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| conference_id | path | required | string |
GET /conferences/{conference_id}
/meetings/{meeting_id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| meeting_id | path | required | number |
GET /meetings/{meeting_id}
/opportunities
default date filter (from/to) is on close_date<br/><br/>setting scope to user gives back all opportunities from the user
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| search | query | optional | string | |
| id | query | optional | number | |
| name | query | optional | string | |
| status | query | optional | string | DEPRECATED |
| stage | query | optional | number | |
| stage.name | query | optional | string | |
| owner | query | optional | number | |
| team_member | query | optional | number | |
| owner_group | query | optional | number | |
| assignee_group | query | optional | number | |
| team_member_group | query | optional | number | |
| account | query | optional | number | |
| assignee | query | optional | number | |
| min_value | query | optional | number | |
| max_value | query | optional | number | |
| close_after | query | optional | string | |
| close_before | query | optional | string | |
| creation_after | query | optional | string | |
| creation_before | query | optional | string | |
| closed | query | optional | boolean | |
| done | query | optional | boolean | |
| tag | query | optional | array | |
| tag.name | query | optional | string | |
| hotness | query | optional | number | 1: Room temp, 2: Hot, 3: On fire |
| limit | query | optional | number | |
| offset | query | optional | number | |
| order_by | query | optional | array | Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. Defaults to asc. |
| pipeline | query | optional | number | |
| custom | query | optional | string | |
| details | query | optional | boolean | |
| q | query | optional | string |
GET /opportunities
/opportunities/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | number |
GET /opportunities/{id}
/persons
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | query | optional | array | |
| name | query | optional | string | |
| query | optional | string | ||
| search | query | optional | string |
GET /persons
/pipelines
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| search | query | optional | string | |
| order_by | query | optional | array | Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. Defaults to asc. |
| q | query | optional | string |
GET /pipelines
/stages
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | query | optional | number | |
| name | query | optional | string | |
| pipeline.id | query | optional | number | |
| pipeline.name | query | optional | string | |
| order_by | query | optional | string |
GET /stages
/stages/{stage_id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| stage_id | path | required | number |
GET /stages/{stage_id}
/currencies
GET /currencies
/tags
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | query | optional | array | |
| name | query | optional | string | This property is deprecated, use q.search instead. When both are provided, q.search will be used. |
| limit | query | optional | number | |
| offset | query | optional | number | |
| order_by | query | optional | array | Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. Defaults to asc. |
| q | query | optional | string |
GET /tags
/tags/{tag_id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| tag_id | path | required | number |
GET /tags/{tag_id}
/tags/{tag_id}/usage
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| tag_id | path | required | number |
GET /tags/{tag_id}/usage
/tasks
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | query | optional | array | |
| search | query | optional | string | |
| assignees | query | optional | array | Defaults to the user |
| type | query | optional | array | |
| account | query | optional | array | |
| order_by | query | optional | array | Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. Defaults to asc. |
| limit | query | optional | number | |
| offset | query | optional | number | |
| q | query | optional | string |
GET /tasks
/me
GET /me
/me/contacts
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | query | optional | array | |
| name | query | optional | string | |
| query | optional | string | ||
| phone_number | query | optional | string | |
| domain | query | optional | string | |
| modification_after | query | optional | string | |
| modification_before | query | optional | string | |
| creation_after | query | optional | string | |
| creation_before | query | optional | string | |
| account | query | optional | array | |
| tag | query | optional | array | |
| tag.name | query | optional | array | |
| position.role | query | optional | array | |
| address.country | query | optional | array | |
| address.state_region | query | optional | array | |
| address.city | query | optional | array | |
| includeArchived | query | optional | boolean | |
| search | query | optional | string | |
| type | query | optional | string | |
| limit | query | optional | number | |
| offset | query | optional | number | |
| custom | query | optional | string | |
| order_by | query | optional | array | Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. Defaults to asc. |
| q | query | optional | string |
GET /me/contacts
/users
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | query | optional | array | |
| name | query | optional | string | |
| query | optional | string | ||
| search | query | optional | string | |
| limit | query | optional | number | |
| offset | query | optional | number | |
| order_by | query | optional | array | Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. Defaults to asc. |
| onlyEnabled | query | optional | boolean |
GET /users
/users/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | number |
GET /users/{id}
/campaigns/mergefields
Note that this route is currently still under `/campaigns` but might be moved in the future.
GET /campaigns/mergefields
/workflows
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | number | |
| offset | query | optional | number | |
| order_by | query | optional | array | Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. Defaults to asc. |
| search | query | optional | string | |
| q | query | optional | string |
GET /workflows
/workflows/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | number |
GET /workflows/{id}
AccountsCreateAccountRequest
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"size": {
"type": "number"
},
"tags": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"team": {
"type": "number"
},
"_dirty": {
"type": "string",
"description": "Deprecated, will be ignored"
},
"_deleted": {
"type": "boolean"
},
"creation_date": {
"type": "string"
},
"modification_date": {
"type": "string"
}
}
}
]
}
},
"email": {
"type": "string",
"x-format": {
"email": {
"tlds": {
"allow": false
},
"ignoreLength": true,
"minDomainSegments": 1
}
},
"maxLength": 1000,
"x-convert": {
"case": "lower",
"trim": true
}
},
"links": {
"type": "string"
},
"owner": {
"type": "number"
},
"_dirty": {
"type": "boolean",
"description": "Deprecated, will be ignored"
},
"custom": {
"type": "object"
},
"domain": {
"type": "string"
},
"address": {
"type": "object"
},
"picture": {
"type": "string"
},
"website": {
"type": "string",
"x-format": {
"uri": {
"allowRelative": true,
"allowQuerySquareBrackets": true
}
}
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"zip": {
"type": "string"
},
"city": {
"type": "string"
},
"_dirty": {
"type": "boolean",
"description": "Deprecated, will be ignored"
},
"region": {
"type": "string",
"description": "Deprecated property. Use state_region instead."
},
"street": {
"type": "string"
},
"country": {
"type": "string"
},
"state_region": {
"type": "string"
}
}
}
},
"customers": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"email": {
"type": "string",
"x-format": {
"email": {
"tlds": {
"allow": false
},
"ignoreLength": true,
"minDomainSegments": 1
}
},
"maxLength": 1000,
"x-convert": {
"case": "lower"
}
}
}
}
},
"description": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"phone_numbers": {
"type": "array",
"items": {
"type": "object",
"required": [
"number"
],
"properties": {
"type": {
"type": "string"
},
"_dirty": {
"type": "boolean",
"description": "Deprecated, will be ignored"
},
"number": {
"type": "string"
}
}
}
},
"parent_account": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}
]
},
"email_addresses": {
"type": "array",
"items": {
"type": "object",
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"x-format": {
"email": {
"tlds": {
"allow": false
},
"ignoreLength": true,
"minDomainSegments": 1
}
},
"maxLength": 1000,
"x-convert": {
"case": "lower",
"trim": true
}
},
"_dirty": {
"type": "boolean",
"description": "Deprecated, will be ignored"
}
}
}
},
"social_profiles": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"url": {
"type": "string"
},
"type": {
"type": "string"
},
"_dirty": {
"type": "boolean",
"description": "Deprecated, will be ignored"
},
"username": {
"type": "string"
}
}
}
]
}
}
}
}
AccountsCreateAccountResponse
{
"type": "string"
}
AccountsListAccountsResponse
{
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"domain"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"size": {
"type": "number"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
}
},
"owner": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"custom": {
"type": "object"
},
"domain": {
"type": "string"
},
"hotness": {
"type": "number"
},
"part_of": {
"type": "boolean"
},
"picture": {
"type": "string"
},
"website": {
"type": "string"
},
"can_edit": {
"type": "boolean"
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"zip": {
"type": "string"
},
"city": {
"type": "string"
},
"type": {
"type": "string"
},
"region": {
"type": "string",
"description": "Deprecated property. Use state_region instead."
},
"street": {
"type": "string"
},
"country": {
"type": "string"
},
"state_region": {
"type": "string"
}
}
}
},
"description": {
"type": "string"
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"phone_numbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"type": {
"type": "string"
},
"number": {
"type": "string"
}
}
}
},
"parent_account": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"domain": {
"type": "string"
},
"entity": {
"enum": [
"account"
],
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"email_addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"email": {
"type": "string"
}
}
}
},
"last_email_date": {
"type": "string",
"format": "date-time"
},
"social_profiles": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"url": {
"type": "string"
},
"type": {
"type": "string"
},
"username": {
"type": "string"
}
}
}
},
"last_interaction": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time"
},
"type": {
"type": "string"
},
"person": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"description": {
"type": "string"
}
}
},
"last_meeting_date": {
"type": "string",
"format": "date-time"
},
"modification_date": {
"type": "string",
"format": "date-time"
},
"last_interaction_date": {
"type": "string",
"format": "date-time"
}
}
}
}
CallsCreateCallRequest
{
"type": "array",
"items": {
"type": "object",
"required": [
"date",
"participants"
],
"properties": {
"date": {
"type": "string",
"format": "date-time"
},
"notes": {
"type": "string"
},
"minutes": {
"type": "string",
"description": "The use of this property is deprecated. Use the notes property instead."
},
"subject": {
"type": "string",
"maxLength": 200
},
"end_date": {
"type": "string",
"format": "date-time"
},
"phone_type": {
"type": "string"
},
"description": {
"type": "string"
},
"participants": {
"type": "array",
"items": {
"type": "number"
},
"description": "No participants is possible for call log sync"
},
"phone_number_hash": {
"type": "string"
}
}
},
"x-constraint": {
"single": true
}
}
CallsCreateCallResponse
{
"type": "string"
}
ContactsCreateContactRequest
{
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"team": {
"type": "number"
},
"_dirty": {
"type": "string",
"description": "Deprecated, will be ignored"
},
"_deleted": {
"type": "boolean"
},
"creation_date": {
"type": "string"
},
"modification_date": {
"type": "string"
}
}
}
]
}
},
"email": {
"type": "string",
"x-format": {
"email": {
"tlds": {
"allow": false
},
"ignoreLength": true,
"minDomainSegments": 1
}
},
"maxLength": 1000,
"x-convert": {
"case": "lower",
"trim": true
}
},
"files": {
"type": "array",
"items": {
"type": "object"
}
},
"owner": {
"type": "number"
},
"custom": {
"type": "object"
},
"middle": {
"type": "string"
},
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
},
"account": {
"type": "number",
"description": "Any existing account will be removed from the contact when specifically passing `null`!"
},
"address": {
"type": "object",
"properties": {
"zip": {
"type": "string"
},
"city": {
"type": "string"
},
"type": {
"type": "string"
},
"region": {
"type": "string",
"description": "Deprecated property. Use state_region instead."
},
"street": {
"type": "string"
},
"country": {
"type": "string"
},
"state_region": {
"type": "string"
}
}
},
"bounced": {
"type": "boolean"
},
"opt-out": {
"type": "boolean"
},
"picture": {
"type": "string",
"maxLength": 500
},
"lastname": {
"type": "string"
},
"position": {
"type": "object",
"properties": {
"role": {
"type": "string"
},
"organisation": {
"type": "string"
}
}
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"zip": {
"type": "string"
},
"city": {
"type": "string"
},
"type": {
"type": "string"
},
"region": {
"type": "string",
"description": "Deprecated property. Use state_region instead."
},
"street": {
"type": "string"
},
"country": {
"type": "string"
},
"state_region": {
"type": "string"
}
}
}
},
"firstname": {
"type": "string"
},
"positions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string"
},
"organisation": {
"type": "string"
}
}
}
},
"birth_date": {
"type": "string",
"format": "date-time"
},
"fax_number": {
"type": "string"
},
"bounced_date": {
"type": "string",
"format": "date-time"
},
"opt-out_date": {
"type": "string",
"format": "date-time"
},
"phone_number": {
"type": "string"
},
"phone_numbers": {
"type": "array",
"items": {
"type": "object",
"required": [
"number"
],
"properties": {
"type": {
"type": "string"
},
"number": {
"type": "string"
}
}
}
},
"social_profiles": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"url": {
"type": "string"
},
"type": {
"type": "string"
},
"username": {
"type": "string"
}
}
}
]
}
},
"opt-out_campaign": {
"type": "string"
},
"home_phone_number": {
"type": "string"
},
"mobile_phone_number": {
"type": "string"
}
}
},
"x-constraint": {
"single": true
}
}
ContactsCreateContactResponse
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
},
"x-constraint": {
"single": true
}
}
ContactsListContactsResponse
{
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
}
},
"type": {
"type": "string"
},
"email": {
"type": "string",
"x-format": {
"email": {
"tlds": {
"allow": false
},
"ignoreLength": true,
"minDomainSegments": 1
}
},
"maxLength": 1000,
"x-convert": {
"case": "lower"
}
},
"files": {
"type": "array",
"items": {
"type": "object"
}
},
"owner": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"custom": {
"type": "object"
},
"domain": {
"type": "string"
},
"middle": {
"type": "string"
},
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
},
"account": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"domain": {
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"bounced": {
"type": "boolean"
},
"opt-out": {
"type": "boolean"
},
"picture": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"can_edit": {
"type": "boolean"
},
"lastname": {
"type": "string"
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"zip": {
"type": "string"
},
"city": {
"type": "string"
},
"type": {
"type": "string"
},
"region": {
"type": "string",
"description": "Deprecated property. Use state_region instead."
},
"street": {
"type": "string"
},
"country": {
"type": "string"
},
"state_region": {
"type": "string"
}
}
}
},
"firstname": {
"type": "string"
},
"positions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"role": {
"type": "string"
},
"organisation": {
"type": "string"
}
}
}
},
"birth_date": {
"type": "string"
},
"fax_number": {
"type": "string"
},
"not_viewed": {
"type": "boolean"
},
"bounced_date": {
"type": "string",
"format": "date-time"
},
"opt-out_date": {
"type": "string",
"format": "date-time"
},
"organisation": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"phone_numbers": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"type": {
"type": "string"
},
"number": {
"type": "string"
}
}
}
},
"last_email_date": {
"type": "string",
"format": "date-time"
},
"social_profiles": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"url": {
"type": "string"
},
"type": {
"type": "string"
},
"username": {
"type": "string"
}
}
}
},
"opt-out_campaign": {
"type": "string"
},
"home_phone_number": {
"type": "string"
},
"last_meeting_date": {
"type": "string",
"format": "date-time"
},
"modification_date": {
"type": "string",
"format": "date-time"
},
"mobile_phone_number": {
"type": "string"
}
}
}
}
CustomFieldsCreateFieldTypeRequest
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "number"
},
"enabled": {
"type": "boolean"
},
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"order": {
"type": "number"
},
"archived": {
"type": "boolean"
}
}
}
},
"archived": {
"type": "boolean"
},
"max_date": {
"type": "string",
"format": "date-time"
},
"min_date": {
"type": "string",
"format": "date-time"
},
"pipeline": {
"type": "number"
},
"required": {
"type": "boolean"
},
"max_number": {
"type": "number"
},
"min_number": {
"type": "number"
},
"order_alphabetically": {
"type": "boolean",
"default": false
},
"default_boolean_value": {
"type": "boolean"
},
"users_can_add_options": {
"type": "boolean"
},
"predefined_customfield": {
"type": "number"
}
}
}
CustomFieldsCreateFieldTypeResponse
{
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}
CustomFieldsDeleteCustomFieldResponse
{
"type": "string"
}
CustomFieldsGetDetailsResponse
{
"type": "string"
}
CustomFieldsListOptionsResponse
{
"type": "string"
}
CustomFieldsListTypeCustomFieldsResponse
{
"type": "string"
}
CustomFieldsListTypesResponse
{
"type": "string"
}
CustomFieldsUpdateFieldRequest
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "number",
"description": "DEPRECATED"
},
"order": {
"type": "number"
},
"enabled": {
"type": "boolean"
},
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"order": {
"type": "number"
},
"archived": {
"type": "boolean"
}
}
}
},
"archived": {
"type": "boolean"
},
"max_date": {
"type": "string",
"format": "date-time"
},
"min_date": {
"type": "string",
"format": "date-time"
},
"pipeline": {
"type": "number"
},
"required": {
"type": "boolean"
},
"max_number": {
"type": "number"
},
"min_number": {
"type": "number"
},
"pipelineName": {
"type": "string"
},
"order_alphabetically": {
"type": "boolean"
},
"users_can_add_options": {
"type": "boolean"
},
"predefined_customfield": {
"type": "number"
}
}
}
CustomFieldsUpdateFieldResponse
{
"type": "string"
}
DeleteAccountsAccountIdResponse
{
"type": "string"
}
DeleteContactsContactIdResponse
{
"type": "string"
}
DeleteMeetingsMeetingIdResponse
{
"type": "string"
}
DeleteMessagesMessageIdResponse
{
"type": "string"
}
DeleteTagsTagIdResponse
{
"type": "object",
"properties": {
"success": {
"enum": [
true
],
"type": "boolean"
}
}
}
EmailDataSourcesListResponse
{
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"aliases",
"email",
"type",
"name",
"team",
"user",
"add_signature_to_campaign",
"add_signature_to_replies",
"max_emails_day",
"max_emails_hour",
"primary",
"status",
"sync_status"
],
"properties": {
"id": {
"type": "number"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"port": {
"type": "number"
},
"team": {
"type": "number"
},
"type": {
"enum": [
"google",
"office365",
"nylas"
],
"type": "string"
},
"user": {
"type": "number"
},
"email": {
"type": "string"
},
"status": {
"enum": [
"OK",
"RECONNECT",
"ERROR"
],
"type": "string"
},
"aliases": {
"type": "array",
"items": {
"type": "object",
"required": [
"email",
"display_name"
],
"properties": {
"email": {
"type": "string",
"x-format": {
"email": {
"tlds": {
"allow": false
},
"ignoreLength": true,
"minDomainSegments": 1
}
},
"x-convert": {
"case": "lower"
}
},
"display_name": {
"type": "string"
}
}
}
},
"primary": {
"type": "boolean"
},
"smtp_host": {
"type": "string"
},
"smtp_port": {
"type": "number"
},
"sync_status": {
"enum": [
"initial",
"cache",
"sync",
"enrich",
"done"
],
"type": "string"
},
"max_emails_day": {
"type": "number"
},
"email_signature": {
"type": "string"
},
"max_emails_hour": {
"type": "number"
},
"store_sent_emails": {
"type": "boolean"
},
"add_signature_to_replies": {
"type": "boolean"
},
"add_signature_to_campaign": {
"type": "boolean"
}
}
}
}
EmailDataSourcesUpdateDataSourceRequest
{
"type": "object",
"properties": {
"max_emails_day": {
"type": "number",
"maximum": 2000,
"minimum": 0
},
"email_signature": {
"type": "string"
},
"max_emails_hour": {
"type": "number",
"maximum": 200,
"minimum": 0
},
"add_signature_to_replies": {
"type": "boolean"
},
"add_signature_to_campaign": {
"type": "boolean"
}
}
}
EmailDataSourcesUpdateDataSourceResponse
{
"type": "string"
}
FilterFieldsListForEntityResponse
{
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"label",
"type",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"group": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"values": {
"type": "object"
},
"enabled": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"id": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"x-constraint": {
"single": true
}
},
"name": {
"type": "string"
},
"order": {
"type": "number"
}
}
}
},
"pipeline": {
"type": "number"
},
"operators": {
"type": "array",
"items": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
}
},
"param_less": {
"type": "boolean"
},
"validation": {
"type": "object"
},
"search_entity": {
"enum": [
"account",
"contact",
"user",
"tag",
"pipeline"
],
"type": "string"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
}
}
}
GetAccountsAccountIdMessagesResponse
{
"type": "string"
}
GetAccountsAccountIdResponse
{
"type": "string"
}
GetConferencesConferenceIdResponse
{
"type": "string"
}
GetContactsContactIdResponse
{
"type": "string"
}
GetMeetingsMeetingIdResponse
{
"type": "string"
}
GetStagesStageIdResponse
{
"type": "string"
}
GetTagsTagIdResponse
{
"type": "string"
}
GetTagsTagIdUsageResponse
{
"type": "string"
}
GroupsGetByIdResponse
{
"type": "string"
}
GroupsListResponse
{
"type": "string"
}
InternalNotesCreateNoteRequest
{
"type": "object",
"required": [
"account",
"body"
],
"properties": {
"body": {
"type": "string"
},
"date": {
"type": "string",
"format": "date-time"
},
"account": {
"type": "number"
},
"mentions": {
"type": "array",
"items": {
"type": "number"
}
}
}
}
InternalNotesCreateNoteResponse
{
"type": "string"
}
MeetingsCreateMeetingRequest
{
"type": "array",
"items": {
"type": "object",
"required": [
"date",
"participants"
],
"properties": {
"date": {
"type": "string",
"format": "date-time"
},
"type": {
"enum": [
"meeting-live",
"meeting-phone"
],
"type": "string",
"default": "meeting-live"
},
"notes": {
"type": "string"
},
"minutes": {
"type": "string",
"description": "The use of this property is deprecated. Use the notes property instead."
},
"subject": {
"type": "string",
"maxLength": 200
},
"end_date": {
"type": "string",
"format": "date-time"
},
"phone_type": {
"type": "string"
},
"description": {
"type": "string"
},
"participants": {
"type": "array",
"items": {
"type": "number"
},
"description": "No participants is possible for call log sync"
},
"phone_number_hash": {
"type": "string"
}
}
},
"x-constraint": {
"single": true
}
}
MeetingsCreateMeetingResponse
{
"type": "string"
}
OpportunitiesCreateOpportunityRequest
{
"type": "object",
"required": [
"account"
],
"properties": {
"name": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"team": {
"type": "number"
},
"_dirty": {
"type": "string",
"description": "Deprecated, will be ignored"
},
"_deleted": {
"type": "boolean"
},
"creation_date": {
"type": "string"
},
"modification_date": {
"type": "string"
}
}
}
]
}
},
"files": {
"type": "array",
"items": {
"type": "object"
}
},
"owner": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
},
"stage": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object",
"required": [
"id",
"order",
"probability"
],
"properties": {
"id": {
"type": "number",
"x-constraint": {
"sign": "positive"
}
},
"order": {
"type": "number"
},
"fixed_stage": {
"type": "number"
},
"probability": {
"type": "number"
}
}
},
{
"type": "string"
}
]
},
"units": {
"type": "number"
},
"value": {
"type": "number",
"minimum": 0
},
"closed": {
"type": "boolean"
},
"custom": {
"type": "object"
},
"status": {
"type": "string",
"description": "DEPRECATED"
},
"account": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object"
}
]
},
"creator": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
},
"assignee": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
},
"currency": {
"type": "number"
},
"frequency": {
"enum": [
"annually",
"weekly",
"monthly",
"daily"
],
"type": "string",
"x-convert": {
"case": "lower"
}
},
"close_date": {
"type": "string",
"format": "date-time"
},
"start_date": {
"type": "string",
"format": "date-time"
},
"lead_source": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
}
]
},
"lost_reason": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
},
{
"type": "string"
}
]
},
"probability": {
"type": "number",
"minimum": 0
},
"status_date": {
"type": "string",
"description": "DEPRECATED"
},
"main_contact": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}
]
},
"contract_end_date": {
"type": "string",
"format": "date-time"
},
"contract_start_date": {
"type": "string",
"format": "date-time"
},
"recurring_price_per_unit": {
"type": "number"
}
}
}
OpportunitiesCreateOpportunityResponse
{
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}
OpportunitiesGetDetailsResponse
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"done": {
"type": "boolean"
},
"name": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
}
},
"files": {
"type": "array",
"items": {
"type": "object"
}
},
"owner": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"picture": {
"type": "string"
},
"disabled": {
"type": "boolean"
}
}
},
"stage": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"order": {
"type": "number"
},
"pipeline": {
"type": "number"
},
"fixed_stage": {
"type": "number"
},
"probability": {
"type": "number"
}
}
},
"units": {
"type": "number"
},
"value": {
"type": "number"
},
"closed": {
"type": "boolean"
},
"custom": {
"type": "object"
},
"account": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"owner": {
"type": "number"
},
"hotness": {
"type": "number"
},
"picture": {
"type": "string"
}
}
},
"creator": {
"type": "number"
},
"assignee": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"can_edit": {
"type": "boolean"
},
"currency": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"iso": {
"type": "string"
},
"html": {
"type": "string"
}
}
},
"pipeline": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
},
"frequency": {
"type": "string"
},
"close_date": {
"type": "string"
},
"start_date": {
"type": "string"
},
"lead_source": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
},
"lost_reason": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"order": {
"type": "number"
}
}
},
"probability": {
"type": "number"
},
"main_contact": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"entity": {
"enum": [
"contact"
],
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"stage_updates": {
"type": "array",
"items": {
"type": "object",
"required": [
"duration_in_seconds"
],
"properties": {
"stage": {
"type": "object",
"required": [
"id",
"order",
"name",
"color"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"order": {
"type": "number"
}
}
},
"duration_in_seconds": {
"type": "number"
}
}
}
},
"calculated_value": {
"type": "number"
},
"last_interaction": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time"
},
"type": {
"type": "string"
},
"person": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"description": {
"type": "string"
}
}
},
"last_modified_by": {
"type": "number"
},
"contract_end_date": {
"type": "string"
},
"modification_date": {
"type": "string",
"format": "date-time"
},
"contract_start_date": {
"type": "string"
},
"recurring_price_per_unit": {
"type": "number"
}
}
}
OpportunitiesListResponse
{
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"done": {
"type": "boolean"
},
"name": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
}
},
"files": {
"type": "array",
"items": {
"type": "object"
}
},
"owner": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"picture": {
"type": "string"
},
"disabled": {
"type": "boolean"
}
}
},
"stage": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"order": {
"type": "number"
},
"fixed_stage": {
"type": "number"
},
"probability": {
"type": "number"
}
}
},
"units": {
"type": "number"
},
"value": {
"type": "number"
},
"closed": {
"type": "boolean"
},
"custom": {
"type": "object"
},
"account": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"hotness": {
"type": "number"
},
"picture": {
"type": "string"
}
}
},
"creator": {
"type": "number"
},
"assignee": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"can_edit": {
"type": "boolean"
},
"currency": {
"type": "object",
"required": [
"iso"
],
"properties": {
"iso": {
"type": "string"
}
}
},
"pipeline": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
},
"frequency": {
"type": "string"
},
"close_date": {
"type": "string"
},
"start_date": {
"type": "string"
},
"lead_source": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
},
"lost_reason": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"order": {
"type": "number"
}
}
},
"probability": {
"type": "number"
},
"main_contact": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"entity": {
"enum": [
"contact"
],
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"calculated_value": {
"type": "number"
},
"last_interaction": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time"
},
"type": {
"type": "string"
},
"person": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"description": {
"type": "string"
}
}
},
"last_modified_by": {
"type": "number"
},
"contract_end_date": {
"type": "string"
},
"modification_date": {
"type": "string",
"format": "date-time"
},
"contract_start_date": {
"type": "string"
},
"last_stage_change_date": {
"type": "string",
"format": "date"
},
"recurring_price_per_unit": {
"type": "number"
}
}
}
}
OpportunitiesRemoveOpportunityResponse
{
"type": "string"
}
OpportunitiesUpdateOpportunityRequest
{
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"name": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"team": {
"type": "number"
},
"_dirty": {
"type": "string",
"description": "Deprecated, will be ignored"
},
"_deleted": {
"type": "boolean"
},
"creation_date": {
"type": "string"
},
"modification_date": {
"type": "string"
}
}
}
]
}
},
"files": {
"type": "array",
"items": {
"type": "object"
}
},
"owner": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object"
}
]
},
"stage": {
"type": "number",
"x-constraint": {
"sign": "positive"
},
"x-alternatives": [
{
"type": "number",
"x-constraint": {
"sign": "positive"
}
},
{
"type": "object",
"required": [
"id",
"order",
"probability"
],
"properties": {
"id": {
"type": "number"
},
"order": {
"type": "number"
},
"fixed_stage": {
"type": "number"
},
"probability": {
"type": "number"
}
}
}
]
},
"units": {
"type": "number"
},
"value": {
"type": "number",
"minimum": 0
},
"closed": {
"type": "boolean"
},
"custom": {
"type": "object"
},
"account": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object"
}
]
},
"creator": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
},
"assignee": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
},
"frequency": {
"enum": [
"annually",
"weekly",
"monthly",
"daily"
],
"type": "string",
"x-convert": {
"case": "lower"
}
},
"close_date": {
"type": "string",
"format": "date-time"
},
"start_date": {
"type": "string",
"format": "date-time"
},
"lead_source": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
}
]
},
"lost_reason": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
}
]
},
"probability": {
"type": "number",
"minimum": 0
},
"main_contact": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}
]
},
"contract_end_date": {
"type": "string",
"format": "date-time"
},
"contract_start_date": {
"type": "string",
"format": "date-time"
},
"recurring_price_per_unit": {
"type": "number"
}
}
}
OpportunitiesUpdateOpportunityResponse
{
"type": "string"
}
PersonsListResponse
{
"type": "string"
}
PipelinesListResponse
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"team": {
"type": "number"
},
"order": {
"type": "number"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
}
},
"stages": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"order": {
"type": "number"
},
"fixed_stage": {
"type": "number"
},
"probability": {
"type": "number"
},
"days_until_account_inactive": {
"type": "number"
}
}
}
},
"archived": {
"type": "boolean"
},
"currency": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"iso": {
"type": "string"
},
"html": {
"type": "string"
}
}
},
"recurring": {
"type": "boolean",
"default": false
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"default_pipeline": {
"type": "boolean"
},
"modification_date": {
"type": "string",
"format": "date-time"
},
"follows_default_team_currency": {
"type": "boolean"
},
"standard_price_per_unit_daily": {
"type": "number"
},
"standard_price_per_unit_weekly": {
"type": "number"
},
"standard_price_per_unit_monthly": {
"type": "number"
},
"standard_price_per_unit_annually": {
"type": "number"
},
"expected_customer_lifetime_months": {
"type": "number"
}
}
}
}
PipelinesListStagesResponse
{
"type": "string"
}
PostAccountsAccountIdContactsRequest
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"_dirty": {
"type": "boolean"
},
"_deleted": {
"type": "boolean"
}
}
},
"minItems": 1,
"x-constraint": {
"single": true
}
}
PostAccountsAccountIdContactsResponse
{
"type": "string"
}
PostAccountsAccountIdUsersResponse
{
"type": "string"
}
PutAccountsAccountIdContactsResponse
{
"type": "string"
}
PutAccountsAccountIdRequest
{
"type": "object",
"properties": {
"q": {
"type": "object",
"required": [
"condition",
"rules"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`",
"x-alternatives": [
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"id",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
}
]
},
"x-constraint": {
"single": true
}
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string",
"description": "`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are deprecated and should not be used."
},
"pipeline": {
"type": "number"
}
}
},
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
}
]
}
},
"valid": {
"type": "boolean"
},
"search": {
"type": "string"
},
"order_by": {
"type": "string"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
},
"name": {
"type": "string"
},
"size": {
"type": "number"
},
"tags": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"team": {
"type": "number"
},
"_dirty": {
"type": "string",
"description": "Deprecated, will be ignored"
},
"_deleted": {
"type": "boolean"
},
"creation_date": {
"type": "string"
},
"modification_date": {
"type": "string"
}
}
}
]
}
},
"email": {
"type": "string",
"x-format": {
"email": {
"tlds": {
"allow": false
},
"ignoreLength": true,
"minDomainSegments": 1
}
},
"maxLength": 1000,
"x-convert": {
"case": "lower",
"trim": true
}
},
"links": {
"type": "string"
},
"_dirty": {
"type": "boolean",
"description": "Deprecated, will be ignored"
},
"custom": {
"type": "object"
},
"domain": {
"type": "string"
},
"address": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"zip": {
"type": "string"
},
"city": {
"type": "string"
},
"_dirty": {
"type": "boolean",
"description": "Deprecated, will be ignored"
},
"region": {
"type": "string",
"description": "Deprecated property. Use state_region instead."
},
"street": {
"type": "string"
},
"country": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"state_region": {
"type": "string"
}
}
},
"picture": {
"type": "string"
},
"website": {
"type": "string",
"x-format": {
"uri": {
"allowRelative": true,
"allowQuerySquareBrackets": true
}
}
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"zip": {
"type": "string"
},
"city": {
"type": "string"
},
"_dirty": {
"type": "boolean",
"description": "Deprecated, will be ignored"
},
"region": {
"type": "string",
"description": "Deprecated property. Use state_region instead."
},
"street": {
"type": "string"
},
"country": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"state_region": {
"type": "string"
}
}
}
},
"description": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"phone_numbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"type": {
"type": "string"
},
"_dirty": {
"type": "boolean",
"description": "Deprecated, will be ignored"
},
"number": {
"type": "string"
},
"archived": {
"type": "boolean"
}
}
}
},
"parent_account": {
"type": "number",
"required": [
"parent_account"
],
"x-alternatives": [
{
"type": "number"
},
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
}
}
}
]
},
"email_addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"email": {
"type": "string",
"x-format": {
"email": {
"tlds": {
"allow": false
},
"ignoreLength": true,
"minDomainSegments": 1
}
},
"maxLength": 1000,
"x-convert": {
"case": "lower",
"trim": true
}
},
"_dirty": {
"type": "boolean",
"description": "Deprecated, will be ignored"
},
"archived": {
"type": "boolean"
}
}
}
},
"social_profiles": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"url": {
"type": "string"
},
"type": {
"type": "string"
},
"_dirty": {
"type": "boolean",
"description": "Deprecated, will be ignored"
},
"archived": {
"type": "boolean"
},
"username": {
"type": "string"
}
}
}
]
}
}
}
}
PutAccountsAccountIdResponse
{
"type": "string"
}
PutAccountsAccountIdUsersResponse
{
"type": "string"
}
PutCallsMeetingIdResponse
{
"type": "string"
}
PutContactsContactIdRequest
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"team": {
"type": "number"
},
"_dirty": {
"type": "string",
"description": "Deprecated, will be ignored"
},
"_deleted": {
"type": "boolean"
},
"creation_date": {
"type": "string"
},
"modification_date": {
"type": "string"
}
}
}
]
}
},
"email": {
"type": "string",
"x-format": {
"email": {
"tlds": {
"allow": false
},
"ignoreLength": true,
"minDomainSegments": 1
}
},
"maxLength": 1000,
"x-convert": {
"case": "lower",
"trim": true
}
},
"files": {
"type": "array",
"items": {
"type": "object"
}
},
"owner": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
}
}
},
{
"type": "string"
}
]
},
"_dirty": {
"type": "boolean",
"description": "Deprecated, will be ignored"
},
"custom": {
"type": "object"
},
"middle": {
"type": "string"
},
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
},
"account": {
"type": "number",
"description": "Any existing account will be removed from the contact when specifically passing `null`!"
},
"address": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"zip": {
"type": "string"
},
"city": {
"type": "string"
},
"type": {
"type": "string"
},
"_dirty": {
"type": "boolean",
"description": "Deprecated, will be ignored"
},
"region": {
"type": "string",
"description": "Deprecated property. Use state_region instead."
},
"street": {
"type": "string"
},
"country": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"state_region": {
"type": "string"
}
}
},
"bounced": {
"type": "boolean"
},
"opt-out": {
"type": "boolean"
},
"picture": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"lastname": {
"type": "string"
},
"position": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"role": {
"type": "string"
},
"_dirty": {
"type": "boolean",
"description": "Deprecated, will be ignored"
},
"archived": {
"type": "boolean"
},
"organisation": {
"type": "string"
}
}
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"zip": {
"type": "string"
},
"city": {
"type": "string"
},
"type": {
"type": "string"
},
"_dirty": {
"type": "boolean",
"description": "Deprecated, will be ignored"
},
"region": {
"type": "string",
"description": "Deprecated property. Use state_region instead."
},
"street": {
"type": "string"
},
"country": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"state_region": {
"type": "string"
}
}
}
},
"firstname": {
"type": "string"
},
"positions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"role": {
"type": "string"
},
"_dirty": {
"type": "boolean",
"description": "Deprecated, will be ignored"
},
"archived": {
"type": "boolean"
},
"organisation": {
"type": "string"
}
}
}
},
"birth_date": {
"type": "string",
"format": "date-time"
},
"fax_number": {
"type": "string"
},
"bounced_date": {
"type": "string",
"format": "date-time"
},
"opt-out_date": {
"type": "string",
"format": "date-time"
},
"phone_number": {
"type": "string"
},
"phone_numbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"type": {
"type": "string"
},
"_dirty": {
"type": "boolean",
"description": "Deprecated, will be ignored"
},
"number": {
"type": "string"
},
"archived": {
"type": "boolean"
}
}
}
},
"social_profiles": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"url": {
"type": "string"
},
"type": {
"type": "string"
},
"_dirty": {
"type": "boolean",
"description": "Deprecated, will be ignored"
},
"archived": {
"type": "boolean"
},
"username": {
"type": "string"
}
}
}
]
}
},
"opt-out_campaign": {
"type": "string"
},
"home_phone_number": {
"type": "string"
},
"mobile_phone_number": {
"type": "string"
}
}
}
PutContactsContactIdResponse
{
"type": "string"
}
PutMeetingsMeetingIdRequest
{
"type": "object",
"required": [
"calendar_id",
"external_id",
"notes"
],
"properties": {
"notes": {
"type": "string",
"description": "The only property you can modify on calendar meetings."
},
"minutes": {
"type": "string",
"description": "The use of this property is deprecated. Use the notes property instead."
},
"edited_by": {
"type": "number"
},
"calendar_id": {
"type": "string"
},
"external_id": {
"type": "string"
}
}
}
PutMeetingsMeetingIdResponse
{
"type": "string"
}
PutMessagesMessageIdResponse
{
"type": "string"
}
PutTagsTagIdResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
}
}
}
PutWorkflowsIdAudienceRecordIdRequest
{
"type": "object",
"properties": {
"exited": {
"type": "boolean",
"description": "Setting `exited` to `true` will exit the entity from the workflow. Setting `exited` to `false` will re-enter the entity into the workflow."
},
"met_goal": {
"type": "boolean",
"description": "Setting `met_goal` of a workflow record to `false` is currently not possible."
}
}
}
PutWorkflowsIdAudienceRecordIdResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
}
}
}
RegionalSettingsListSupportedCurrenciesResponse
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"iso": {
"type": "string",
"x-constraint": {
"length": 3
}
},
"html": {
"type": "string"
}
}
}
}
TagsCreateTagRequest
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
}
}
}
TagsCreateTagResponse
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
}
}
}
TagsListResponse
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"team": {
"type": "number"
},
"automated": {
"type": "boolean"
},
"total_count": {
"type": "number"
},
"person_count": {
"type": "number"
},
"account_count": {
"type": "number"
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"modification_date": {
"type": "string",
"format": "date-time"
},
"opportunity_count": {
"type": "number"
}
}
}
}
TasksCreateTaskRequest
{
"type": "array",
"items": {
"type": "object",
"required": [
"description"
],
"properties": {
"account": {
"type": "number"
},
"assignees": {
"type": "array",
"items": {
"type": "number"
},
"x-constraint": {
"single": true
}
},
"description": {
"type": "string"
},
"reminder_date": {
"type": "string",
"format": "date",
"default": "2024-04-16T17:55:24.837Z"
}
}
},
"x-constraint": {
"single": true
}
}
TasksCreateTaskResponse
{
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}
TasksDeleteTaskResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
}
}
}
TasksListTasksResponse
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"type": {
"enum": [
"meeting_notes",
"email_reply",
"account_inactive",
"suggested_contact",
"suggested_account",
"manual_task",
"meeting"
],
"type": "string"
},
"email": {
"type": "object",
"required": [
"id",
"email_message_id",
"subject"
],
"properties": {
"id": {
"type": "number"
},
"subject": {
"type": "string"
},
"data_source": {
"type": "number"
},
"email_message_id": {
"type": "string"
},
"service_message_id": {
"type": "string"
}
}
},
"account": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"company": {
"type": "number"
},
"creator": {
"type": "number"
},
"meeting": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"subject": {
"type": "string"
},
"conference_url": {
"type": "string"
}
}
},
"archived": {
"type": "boolean"
},
"archivor": {
"type": "number"
},
"can_edit": {
"type": "boolean"
},
"assignees": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"picture": {
"type": "string"
},
"disabled": {
"type": "boolean"
}
}
}
},
"completed": {
"type": "boolean"
},
"completor": {
"type": "number"
},
"description": {
"type": "string"
},
"archive_date": {
"type": "string",
"format": "date-time"
},
"meeting_type": {
"type": "boolean"
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"reminder_date": {
"type": "string",
"format": "date-time"
},
"completion_date": {
"type": "string",
"format": "date-time"
},
"last_modified_by": {
"type": "number"
},
"modification_date": {
"type": "string",
"format": "date-time"
}
}
}
}
TasksUpdateTaskRequest
{
"type": "object",
"properties": {
"account": {
"type": "number"
},
"assignees": {
"type": "array",
"items": {
"type": "number"
},
"x-constraint": {
"single": true
}
},
"completed": {
"type": "boolean"
},
"description": {
"type": "string"
},
"reminder_date": {
"type": "string",
"format": "date"
}
}
}
TasksUpdateTaskResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
}
}
}
UsersGetCurrentUserDetailsResponse
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"role": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"permissions": {
"type": "object",
"properties": {
"ced": {
"enum": [
"CED",
"VIEW"
],
"type": "string"
},
"view": {
"enum": [
"CED",
"VIEW"
],
"type": "string"
}
}
}
}
},
"tags": {
"type": "array",
"items": {
"type": "object"
}
},
"team": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"plan": {
"type": "number"
},
"domain": {
"type": "string"
},
"campaign": {
"type": "string"
},
"currency": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"iso": {
"type": "string"
},
"html": {
"type": "string"
}
}
},
"time_zone": {
"type": "string"
},
"free_users": {
"type": "number"
},
"promo_code": {
"type": "string"
},
"subscribed": {
"type": "boolean"
},
"is_referred": {
"type": "boolean"
},
"credit_quota": {
"type": "number"
},
"credit_usage": {
"type": "number"
},
"payment_type": {
"enum": [
"stripe",
"free",
"appstack"
],
"type": "string"
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"discount_code": {
"type": "string"
},
"discount_type": {
"type": "string"
},
"credit_package": {
"enum": [
"S",
"M",
"L",
"XL"
],
"type": "string"
},
"tracking_token": {
"type": "string"
},
"paid_user_count": {
"type": "number"
},
"promo_redeem_by": {
"type": "string",
"format": "date-time"
},
"billing_currency": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"iso": {
"type": "string"
},
"html": {
"type": "string"
}
}
},
"total_user_count": {
"type": "number"
},
"automated_tagging": {
"type": "boolean"
},
"billing_frequency": {
"enum": [
"monthly",
"annually"
],
"type": "string"
},
"promo_description": {
"type": "string"
},
"enabled_user_count": {
"type": "number"
},
"stripe_customer_id": {
"type": "string"
},
"email_tracking_domain": {
"type": "object",
"required": [
"url",
"enabled"
],
"properties": {
"url": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"timeZones": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"email_tracking_subdomain": {
"type": "string"
},
"days_until_account_inactive": {
"type": "number"
}
}
},
"type": {
"type": "string"
},
"email": {
"type": "string",
"x-format": {
"email": {
"tlds": {
"allow": false
},
"ignoreLength": true,
"minDomainSegments": 1
}
}
},
"flags": {
"type": "array",
"items": {
"type": "object",
"required": [
"flag",
"name",
"state"
],
"properties": {
"id": {
"type": "number"
},
"flag": {
"type": "number"
},
"name": {
"type": "string"
},
"plan": {
"type": "number"
},
"user": {
"type": "number"
},
"state": {
"type": "boolean"
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"modification_date": {
"type": "string",
"format": "date-time"
}
}
}
},
"group": {
"type": "number"
},
"domain": {
"type": "string"
},
"middle": {
"type": "string"
},
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
},
"picture": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"is_admin": {
"type": "boolean"
},
"lastname": {
"type": "string"
},
"addresses": {
"type": "array",
"items": {
"type": "object"
}
},
"firstname": {
"type": "string"
},
"positions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"role": {
"type": "string"
},
"organisation": {
"type": "string"
}
}
}
},
"plan_flags": {
"type": "object"
},
"restricted": {
"type": "boolean"
},
"sync_status": {
"type": "string"
},
"credit_usage": {
"type": "number"
},
"data_sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"type": {
"type": "string"
},
"email": {
"type": "string"
},
"status": {
"enum": [
"ERROR",
"RECONNECT",
"OK"
],
"type": "string"
},
"sync_status": {
"type": "string"
},
"status_message": {
"type": "string"
}
}
}
},
"is_importing": {
"type": "boolean"
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"intercom_hash": {
"type": "string",
"x-format": {
"hex": {
"byteAligned": false
}
}
},
"is_delinquent": {
"type": "boolean"
},
"phone_numbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"type": {
"type": "string"
},
"number": {
"type": "string"
}
}
}
},
"referral_code": {
"type": "string"
},
"trial_expired": {
"type": "boolean"
},
"am_pm_notation": {
"type": "boolean"
},
"needs_password": {
"type": "boolean"
},
"trial_extended": {
"type": "boolean"
},
"two_fa_enabled": {
"type": "boolean"
},
"referral_reward": {
"type": "number"
},
"social_profiles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"url": {
"type": "string"
},
"type": {
"type": "string"
},
"username": {
"type": "string"
}
}
}
},
"first_day_of_week": {
"type": "number"
},
"modification_date": {
"type": "string",
"format": "date-time"
},
"restricted_reason": {
"type": "string"
},
"trial_expiry_date": {
"type": "string",
"format": "date-time"
},
"call_log_sync_date": {
"type": "string",
"format": "date-time"
},
"team_discount_code": {
"type": "string"
},
"calendar_sync_status": {
"type": "string"
},
"has_archived_contacts": {
"type": "boolean"
},
"notification_channel_id": {
"type": "string"
},
"auto_find_email_linkedin": {
"type": "boolean"
},
"first_calendar_sync_done": {
"type": "boolean"
},
"data_sources_to_reconnect": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"type": {
"type": "string"
},
"email": {
"type": "string"
}
}
}
},
"amount_of_trial_days_earned": {
"type": "number"
},
"has_received_account_suggestions": {
"type": "boolean"
}
}
}
UsersGetUserDetailsResponse
{
"type": "string"
}
UsersListContactsResponse
{
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
}
},
"type": {
"type": "string"
},
"email": {
"type": "string",
"x-format": {
"email": {
"tlds": {
"allow": false
},
"ignoreLength": true,
"minDomainSegments": 1
}
},
"maxLength": 1000,
"x-convert": {
"case": "lower"
}
},
"files": {
"type": "array",
"items": {
"type": "object"
}
},
"owner": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"custom": {
"type": "object"
},
"domain": {
"type": "string"
},
"middle": {
"type": "string"
},
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
},
"account": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"domain": {
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"bounced": {
"type": "boolean"
},
"opt-out": {
"type": "boolean"
},
"picture": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"can_edit": {
"type": "boolean"
},
"lastname": {
"type": "string"
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"zip": {
"type": "string"
},
"city": {
"type": "string"
},
"type": {
"type": "string"
},
"region": {
"type": "string",
"description": "Deprecated property. Use state_region instead."
},
"street": {
"type": "string"
},
"country": {
"type": "string"
},
"state_region": {
"type": "string"
}
}
}
},
"firstname": {
"type": "string"
},
"positions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"role": {
"type": "string"
},
"organisation": {
"type": "string"
}
}
}
},
"birth_date": {
"type": "string"
},
"fax_number": {
"type": "string"
},
"not_viewed": {
"type": "boolean"
},
"bounced_date": {
"type": "string",
"format": "date-time"
},
"opt-out_date": {
"type": "string",
"format": "date-time"
},
"organisation": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"phone_numbers": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"type": {
"type": "string"
},
"number": {
"type": "string"
}
}
}
},
"last_email_date": {
"type": "string",
"format": "date-time"
},
"social_profiles": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"url": {
"type": "string"
},
"type": {
"type": "string"
},
"username": {
"type": "string"
}
}
}
},
"opt-out_campaign": {
"type": "string"
},
"home_phone_number": {
"type": "string"
},
"last_meeting_date": {
"type": "string",
"format": "date-time"
},
"modification_date": {
"type": "string",
"format": "date-time"
},
"mobile_phone_number": {
"type": "string"
}
}
}
}
UsersListResponse
{
"type": "string"
}
WorkflowsCreateWorkflowRequest
{
"type": "object",
"required": [
"name"
],
"properties": {
"goal": {
"enum": [
"opened",
"clicked",
"replied"
],
"type": "string"
},
"name": {
"type": "string"
},
"steps": {
"type": "array",
"items": {
"type": "object",
"required": [
"order"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"order": {
"type": "number"
},
"filter": {
"type": "object",
"required": [
"condition",
"rules"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`",
"x-alternatives": [
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"id",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
}
]
},
"x-constraint": {
"single": true
}
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string",
"description": "`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are deprecated and should not be used."
},
"pipeline": {
"type": "number"
}
}
},
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
}
]
}
},
"valid": {
"type": "boolean"
},
"search": {
"type": "string"
},
"order_by": {
"type": "string"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"x-alternatives": [
{
"type": "object",
"required": [
"condition",
"rules"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`",
"x-alternatives": [
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"id",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
}
]
},
"x-constraint": {
"single": true
}
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string",
"description": "`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are deprecated and should not be used."
},
"pipeline": {
"type": "number"
}
}
},
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
}
]
}
},
"valid": {
"type": "boolean"
},
"search": {
"type": "string"
},
"order_by": {
"type": "string"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
},
{
"type": "array",
"items": {
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`",
"x-alternatives": [
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"id",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
}
]
},
"x-constraint": {
"single": true
}
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string",
"description": "`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are deprecated and should not be used."
},
"pipeline": {
"type": "number"
}
}
},
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
}
]
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"x-alternatives": [
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
},
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"id",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
}
]
},
"x-constraint": {
"single": true
}
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string",
"description": "`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are deprecated and should not be used."
},
"pipeline": {
"type": "number"
}
}
}
]
}
}
]
},
"trigger": {
"enum": [
"sent",
"opened",
"clicked",
"replied",
"not_opened",
"not_replied",
"not_clicked"
],
"type": "string"
},
"analytics": {
"type": "object",
"properties": {
"sent": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
},
"total": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
},
"failed": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
},
"replied": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
},
"interacted": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
}
}
},
"action_type": {
"enum": [
"send_email"
],
"type": "string"
},
"metrics_data": {
"type": "object"
},
"trigger_step": {
"type": "number"
},
"action_config": {
"type": "object"
},
"action_source": {
"type": "number"
},
"action_status": {
"type": "string"
},
"trigger_after_days": {
"type": "number"
},
"trigger_step_index": {
"type": "number"
},
"action_source_email": {
"type": "string",
"x-format": {
"email": {
"tlds": {
"allow": false
},
"ignoreLength": true,
"minDomainSegments": 1
}
}
}
}
}
},
"filter": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "number"
},
"x-constraint": {
"single": true
}
}
},
"description": "When you pass `ids` all other filter options will be ignored",
"x-alternatives": [
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "number"
},
"x-constraint": {
"single": true
}
}
},
"description": "When you pass `ids` all other filter options will be ignored"
},
{
"type": "object",
"required": [
"condition",
"rules"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`",
"x-alternatives": [
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"id",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
}
]
},
"x-constraint": {
"single": true
}
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string",
"description": "`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are deprecated and should not be used."
},
"pipeline": {
"type": "number"
}
}
},
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
}
]
}
},
"valid": {
"type": "boolean"
},
"search": {
"type": "string"
},
"order_by": {
"type": "string"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"x-alternatives": [
{
"type": "object",
"required": [
"condition",
"rules"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`",
"x-alternatives": [
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"id",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
}
]
},
"x-constraint": {
"single": true
}
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string",
"description": "`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are deprecated and should not be used."
},
"pipeline": {
"type": "number"
}
}
},
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
}
]
}
},
"valid": {
"type": "boolean"
},
"search": {
"type": "string"
},
"order_by": {
"type": "string"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
},
{
"type": "array",
"items": {
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`",
"x-alternatives": [
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"id",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
}
]
},
"x-constraint": {
"single": true
}
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string",
"description": "`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are deprecated and should not be used."
},
"pipeline": {
"type": "number"
}
}
},
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
}
]
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"x-alternatives": [
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
},
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"id",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
}
]
},
"x-constraint": {
"single": true
}
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string",
"description": "`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are deprecated and should not be used."
},
"pipeline": {
"type": "number"
}
}
}
]
}
}
]
}
]
},
"status": {
"enum": [
"live",
"paused",
"scheduled",
"draft"
],
"type": "string"
},
"continuous": {
"type": "boolean"
},
"record_type": {
"enum": [
"contact"
],
"type": "string"
},
"schedule_date": {
"type": "string",
"format": "date-time"
},
"schedule_days": {
"type": "array",
"items": {
"type": "number",
"maximum": 6,
"minimum": 0
}
},
"status_message": {
"type": "string"
},
"exit_after_days": {
"type": "number"
},
"schedule_time_end": {
"type": "string",
"pattern": "^([0-1]?[0-9]|2[0-3]):[0-5][0-9]:\\d{2}$"
},
"schedule_time_start": {
"type": "string",
"pattern": "^([0-1]?[0-9]|2[0-3]):[0-5][0-9]:\\d{2}$"
},
"individual_record_filter": {
"type": "object",
"required": [
"condition",
"rules"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`",
"x-alternatives": [
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"id",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
}
]
},
"x-constraint": {
"single": true
}
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string",
"description": "`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are deprecated and should not be used."
},
"pipeline": {
"type": "number"
}
}
},
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
}
]
}
},
"valid": {
"type": "boolean"
},
"search": {
"type": "string"
},
"order_by": {
"type": "string"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"x-alternatives": [
{
"type": "object",
"required": [
"condition",
"rules"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`",
"x-alternatives": [
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"id",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
}
]
},
"x-constraint": {
"single": true
}
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string",
"description": "`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are deprecated and should not be used."
},
"pipeline": {
"type": "number"
}
}
},
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
}
]
}
},
"valid": {
"type": "boolean"
},
"search": {
"type": "string"
},
"order_by": {
"type": "string"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
},
{
"type": "array",
"items": {
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`",
"x-alternatives": [
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"id",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
}
]
},
"x-constraint": {
"single": true
}
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string",
"description": "`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are deprecated and should not be used."
},
"pipeline": {
"type": "number"
}
}
},
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
}
]
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"x-alternatives": [
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
},
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"id",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
}
]
},
"x-constraint": {
"single": true
}
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string",
"description": "`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are deprecated and should not be used."
},
"pipeline": {
"type": "number"
}
}
}
]
}
}
]
}
}
}
WorkflowsCreateWorkflowResponse
{
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}
WorkflowsGetDetailsResponse
{
"type": "object",
"required": [
"id",
"team"
],
"properties": {
"id": {
"type": "number"
},
"goal": {
"enum": [
"opened",
"clicked",
"replied"
],
"type": "string"
},
"name": {
"type": "string"
},
"team": {
"type": "number"
},
"steps": {
"type": "array",
"items": {
"type": "object",
"required": [
"order",
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"team": {
"type": "number"
},
"order": {
"type": "number"
},
"filter": {
"type": "object",
"required": [
"condition",
"rules"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`",
"x-alternatives": [
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"id",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
}
]
},
"x-constraint": {
"single": true
}
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string",
"description": "`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are deprecated and should not be used."
},
"pipeline": {
"type": "number"
}
}
},
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
}
]
}
},
"valid": {
"type": "boolean"
},
"search": {
"type": "string"
},
"order_by": {
"type": "string"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"x-alternatives": [
{
"type": "object",
"required": [
"condition",
"rules"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`",
"x-alternatives": [
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"id",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
}
]
},
"x-constraint": {
"single": true
}
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string",
"description": "`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are deprecated and should not be used."
},
"pipeline": {
"type": "number"
}
}
},
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
}
]
}
},
"valid": {
"type": "boolean"
},
"search": {
"type": "string"
},
"order_by": {
"type": "string"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
},
{
"type": "array",
"items": {
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`",
"x-alternatives": [
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"id",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
}
]
},
"x-constraint": {
"single": true
}
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string",
"description": "`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are deprecated and should not be used."
},
"pipeline": {
"type": "number"
}
}
},
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
}
]
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"x-alternatives": [
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
},
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"id",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
}
]
},
"x-constraint": {
"single": true
}
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string",
"description": "`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are deprecated and should not be used."
},
"pipeline": {
"type": "number"
}
}
}
]
}
}
]
},
"trigger": {
"enum": [
"sent",
"opened",
"clicked",
"replied",
"not_opened",
"not_replied",
"not_clicked"
],
"type": "string"
},
"archived": {
"type": "boolean"
},
"workflow": {
"type": "number"
},
"analytics": {
"type": "object",
"properties": {
"sent": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
},
"total": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
},
"failed": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
},
"replied": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
},
"interacted": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
}
}
},
"created_by": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"action_type": {
"enum": [
"send_email"
],
"type": "string"
},
"archived_by": {
"type": "number"
},
"metrics_data": {
"type": "object"
},
"trigger_step": {
"type": "number"
},
"action_config": {
"type": "object"
},
"action_source": {
"type": "number"
},
"action_status": {
"type": "string"
},
"archived_date": {
"type": "string",
"format": "date-time"
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"last_modified_by": {
"type": "number"
},
"modification_date": {
"type": "string",
"format": "date-time"
},
"trigger_after_days": {
"type": "number"
},
"trigger_step_index": {
"type": "number"
},
"action_source_email": {
"type": "string",
"x-format": {
"email": {
"tlds": {
"allow": false
},
"ignoreLength": true,
"minDomainSegments": 1
}
}
}
}
}
},
"filter": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "number"
},
"x-constraint": {
"single": true
}
}
},
"x-alternatives": [
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "number"
},
"x-constraint": {
"single": true
}
}
}
},
{
"type": "object",
"required": [
"condition",
"rules"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"group": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object"
}
},
"archived": {
"type": "boolean"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"raw_value": {
"type": "array",
"items": {
"type": "object"
}
},
"search_entity": {
"enum": [
"account",
"contact",
"user",
"tag",
"pipeline"
],
"type": "string"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`",
"x-alternatives": [
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"group": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object"
}
},
"archived": {
"type": "boolean"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"raw_value": {
"type": "array",
"items": {
"type": "object"
}
},
"search_entity": {
"enum": [
"account",
"contact",
"user",
"tag",
"pipeline"
],
"type": "string"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"group": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object"
}
},
"archived": {
"type": "boolean"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"raw_value": {
"type": "array",
"items": {
"type": "object"
}
},
"search_entity": {
"enum": [
"account",
"contact",
"user",
"tag",
"pipeline"
],
"type": "string"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
}
]
}
},
"valid": {
"type": "boolean"
},
"search": {
"type": "string"
},
"order_by": {
"type": "string"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
}
]
},
"status": {
"enum": [
"draft",
"live",
"paused",
"finished",
"failed",
"scheduled"
],
"type": "string"
},
"archived": {
"type": "boolean"
},
"can_edit": {
"type": "boolean"
},
"analytics": {
"type": "object",
"properties": {
"in": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
},
"total": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
},
"exited": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
},
"met_goal": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
}
}
},
"continuous": {
"type": "boolean"
},
"created_by": {
"type": "number"
},
"record_type": {
"enum": [
"contact"
],
"type": "string"
},
"step_amount": {
"type": "number"
},
"creator_name": {
"type": "string"
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"schedule_date": {
"type": "string",
"format": "date-time"
},
"schedule_days": {
"type": "array",
"items": {
"type": "number",
"maximum": 6,
"minimum": 0
}
},
"status_message": {
"type": "string"
},
"workflow_steps": {
"type": "array",
"items": {
"type": "object",
"required": [
"order",
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"team": {
"type": "number"
},
"order": {
"type": "number"
},
"filter": {
"type": "object",
"required": [
"condition",
"rules"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`",
"x-alternatives": [
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"id",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
}
]
},
"x-constraint": {
"single": true
}
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string",
"description": "`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are deprecated and should not be used."
},
"pipeline": {
"type": "number"
}
}
},
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
}
]
}
},
"valid": {
"type": "boolean"
},
"search": {
"type": "string"
},
"order_by": {
"type": "string"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"x-alternatives": [
{
"type": "object",
"required": [
"condition",
"rules"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`",
"x-alternatives": [
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"id",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
}
]
},
"x-constraint": {
"single": true
}
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string",
"description": "`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are deprecated and should not be used."
},
"pipeline": {
"type": "number"
}
}
},
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
}
]
}
},
"valid": {
"type": "boolean"
},
"search": {
"type": "string"
},
"order_by": {
"type": "string"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
},
{
"type": "array",
"items": {
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`",
"x-alternatives": [
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"id",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
}
]
},
"x-constraint": {
"single": true
}
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string",
"description": "`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are deprecated and should not be used."
},
"pipeline": {
"type": "number"
}
}
},
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
}
]
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"x-alternatives": [
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
},
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"id",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
}
]
},
"x-constraint": {
"single": true
}
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string",
"description": "`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are deprecated and should not be used."
},
"pipeline": {
"type": "number"
}
}
}
]
}
}
]
},
"trigger": {
"enum": [
"sent",
"opened",
"clicked",
"replied",
"not_opened",
"not_replied",
"not_clicked"
],
"type": "string"
},
"archived": {
"type": "boolean"
},
"workflow": {
"type": "number"
},
"analytics": {
"type": "object",
"properties": {
"sent": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
},
"total": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
},
"failed": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
},
"replied": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
},
"interacted": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
}
}
},
"created_by": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"action_type": {
"enum": [
"send_email"
],
"type": "string"
},
"archived_by": {
"type": "number"
},
"metrics_data": {
"type": "object"
},
"trigger_step": {
"type": "number"
},
"action_config": {
"type": "object"
},
"action_source": {
"type": "number"
},
"action_status": {
"type": "string"
},
"archived_date": {
"type": "string",
"format": "date-time"
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"last_modified_by": {
"type": "number"
},
"modification_date": {
"type": "string",
"format": "date-time"
},
"trigger_after_days": {
"type": "number"
},
"trigger_step_index": {
"type": "number"
},
"action_source_email": {
"type": "string",
"x-format": {
"email": {
"tlds": {
"allow": false
},
"ignoreLength": true,
"minDomainSegments": 1
}
}
}
}
}
},
"exit_after_days": {
"type": "number"
},
"last_modified_by": {
"type": "number"
},
"modification_date": {
"type": "string",
"format": "date-time"
},
"schedule_time_end": {
"type": "string",
"pattern": "^([0-1]?[0-9]|2[0-3]):[0-5][0-9]:\\d{2}$"
},
"schedule_time_start": {
"type": "string",
"pattern": "^([0-1]?[0-9]|2[0-3]):[0-5][0-9]:\\d{2}$"
},
"individual_record_filter": {
"type": "object",
"required": [
"condition",
"rules"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"group": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object"
}
},
"archived": {
"type": "boolean"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"raw_value": {
"type": "array",
"items": {
"type": "object"
}
},
"search_entity": {
"enum": [
"account",
"contact",
"user",
"tag",
"pipeline"
],
"type": "string"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`",
"x-alternatives": [
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"group": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object"
}
},
"archived": {
"type": "boolean"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"raw_value": {
"type": "array",
"items": {
"type": "object"
}
},
"search_entity": {
"enum": [
"account",
"contact",
"user",
"tag",
"pipeline"
],
"type": "string"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"group": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object"
}
},
"archived": {
"type": "boolean"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"raw_value": {
"type": "array",
"items": {
"type": "object"
}
},
"search_entity": {
"enum": [
"account",
"contact",
"user",
"tag",
"pipeline"
],
"type": "string"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
}
]
}
},
"valid": {
"type": "boolean"
},
"search": {
"type": "string"
},
"order_by": {
"type": "string"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
},
"scheduled_before_pro_release": {
"type": "boolean"
},
"multi_step_before_pro_release": {
"type": "boolean"
}
}
}
WorkflowsGetMergeFieldsResponse
{
"type": "array",
"items": {
"type": "object",
"required": [
"entity_type",
"display_name"
],
"properties": {
"api_field": {
"type": "string"
},
"is_custom": {
"type": "boolean"
},
"custom_type": {
"type": "string"
},
"entity_type": {
"enum": [
"account",
"contact"
],
"type": "string"
},
"display_name": {
"type": "string"
}
}
}
}
WorkflowsListResponse
{
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"team"
],
"properties": {
"id": {
"type": "number"
},
"goal": {
"enum": [
"opened",
"clicked",
"replied"
],
"type": "string"
},
"name": {
"type": "string"
},
"team": {
"type": "number"
},
"steps": {
"type": "array",
"items": {
"type": "object",
"required": [
"order",
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"team": {
"type": "number"
},
"order": {
"type": "number"
},
"filter": {
"type": "object",
"required": [
"condition",
"rules"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`",
"x-alternatives": [
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"id",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
}
]
},
"x-constraint": {
"single": true
}
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string",
"description": "`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are deprecated and should not be used."
},
"pipeline": {
"type": "number"
}
}
},
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
}
]
}
},
"valid": {
"type": "boolean"
},
"search": {
"type": "string"
},
"order_by": {
"type": "string"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"x-alternatives": [
{
"type": "object",
"required": [
"condition",
"rules"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`",
"x-alternatives": [
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"id",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
}
]
},
"x-constraint": {
"single": true
}
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string",
"description": "`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are deprecated and should not be used."
},
"pipeline": {
"type": "number"
}
}
},
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
}
]
}
},
"valid": {
"type": "boolean"
},
"search": {
"type": "string"
},
"order_by": {
"type": "string"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
},
{
"type": "array",
"items": {
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`",
"x-alternatives": [
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"id",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
}
]
},
"x-constraint": {
"single": true
}
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string",
"description": "`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are deprecated and should not be used."
},
"pipeline": {
"type": "number"
}
}
},
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
}
]
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"x-alternatives": [
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
},
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"id",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
}
]
},
"x-constraint": {
"single": true
}
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string",
"description": "`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are deprecated and should not be used."
},
"pipeline": {
"type": "number"
}
}
}
]
}
}
]
},
"trigger": {
"enum": [
"sent",
"opened",
"clicked",
"replied",
"not_opened",
"not_replied",
"not_clicked"
],
"type": "string"
},
"archived": {
"type": "boolean"
},
"workflow": {
"type": "number"
},
"analytics": {
"type": "object",
"properties": {
"sent": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
},
"total": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
},
"failed": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
},
"replied": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
},
"interacted": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
}
}
},
"created_by": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"action_type": {
"enum": [
"send_email"
],
"type": "string"
},
"archived_by": {
"type": "number"
},
"metrics_data": {
"type": "object"
},
"trigger_step": {
"type": "number"
},
"action_config": {
"type": "object"
},
"action_source": {
"type": "number"
},
"action_status": {
"type": "string"
},
"archived_date": {
"type": "string",
"format": "date-time"
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"last_modified_by": {
"type": "number"
},
"modification_date": {
"type": "string",
"format": "date-time"
},
"trigger_after_days": {
"type": "number"
},
"trigger_step_index": {
"type": "number"
},
"action_source_email": {
"type": "string",
"x-format": {
"email": {
"tlds": {
"allow": false
},
"ignoreLength": true,
"minDomainSegments": 1
}
}
}
}
}
},
"filter": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "number"
},
"x-constraint": {
"single": true
}
}
},
"x-alternatives": [
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "number"
},
"x-constraint": {
"single": true
}
}
}
},
{
"type": "object",
"required": [
"condition",
"rules"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"group": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object"
}
},
"archived": {
"type": "boolean"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"raw_value": {
"type": "array",
"items": {
"type": "object"
}
},
"search_entity": {
"enum": [
"account",
"contact",
"user",
"tag",
"pipeline"
],
"type": "string"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`",
"x-alternatives": [
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"group": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object"
}
},
"archived": {
"type": "boolean"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"raw_value": {
"type": "array",
"items": {
"type": "object"
}
},
"search_entity": {
"enum": [
"account",
"contact",
"user",
"tag",
"pipeline"
],
"type": "string"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"group": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object"
}
},
"archived": {
"type": "boolean"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"raw_value": {
"type": "array",
"items": {
"type": "object"
}
},
"search_entity": {
"enum": [
"account",
"contact",
"user",
"tag",
"pipeline"
],
"type": "string"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
}
]
}
},
"valid": {
"type": "boolean"
},
"search": {
"type": "string"
},
"order_by": {
"type": "string"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
}
]
},
"status": {
"enum": [
"draft",
"live",
"paused",
"finished",
"failed",
"scheduled"
],
"type": "string"
},
"archived": {
"type": "boolean"
},
"can_edit": {
"type": "boolean"
},
"analytics": {
"type": "object",
"properties": {
"in": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
},
"total": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
},
"exited": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
},
"met_goal": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"absolute",
"percentage"
],
"type": "string"
},
"value": {
"type": "number"
}
}
}
}
},
"continuous": {
"type": "boolean"
},
"created_by": {
"type": "number"
},
"record_type": {
"enum": [
"contact"
],
"type": "string"
},
"step_amount": {
"type": "number"
},
"creator_name": {
"type": "string"
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"schedule_date": {
"type": "string",
"format": "date-time"
},
"schedule_days": {
"type": "array",
"items": {
"type": "number",
"maximum": 6,
"minimum": 0
}
},
"status_message": {
"type": "string"
},
"exit_after_days": {
"type": "number"
},
"last_modified_by": {
"type": "number"
},
"modification_date": {
"type": "string",
"format": "date-time"
},
"schedule_time_end": {
"type": "string",
"pattern": "^([0-1]?[0-9]|2[0-3]):[0-5][0-9]:\\d{2}$"
},
"schedule_time_start": {
"type": "string",
"pattern": "^([0-1]?[0-9]|2[0-3]):[0-5][0-9]:\\d{2}$"
},
"individual_record_filter": {
"type": "object",
"required": [
"condition",
"rules"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"group": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object"
}
},
"archived": {
"type": "boolean"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"raw_value": {
"type": "array",
"items": {
"type": "object"
}
},
"search_entity": {
"enum": [
"account",
"contact",
"user",
"tag",
"pipeline"
],
"type": "string"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`",
"x-alternatives": [
{
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"group": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object"
}
},
"archived": {
"type": "boolean"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"raw_value": {
"type": "array",
"items": {
"type": "object"
}
},
"search_entity": {
"enum": [
"account",
"contact",
"user",
"tag",
"pipeline"
],
"type": "string"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
},
{
"type": "object",
"required": [
"condition"
],
"properties": {
"not": {
"type": "boolean"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"operator",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"integer",
"double",
"boolean",
"tri_state_boolean",
"string",
"long_string",
"select",
"date",
"datetime",
"file"
],
"type": "string"
},
"group": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"value1": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value2": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
]
},
"x-constraint": {
"single": true
}
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"enabled": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object"
}
},
"archived": {
"type": "boolean"
},
"internal": {
"type": "boolean"
},
"operator": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
},
"pipeline": {
"type": "number"
},
"raw_value": {
"type": "array",
"items": {
"type": "object"
}
},
"search_entity": {
"enum": [
"account",
"contact",
"user",
"tag",
"pipeline"
],
"type": "string"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
},
"description": "Deprecated, please use the slim version with only `id`, `operator`, `value`"
}
},
"valid": {
"type": "boolean"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
}
]
}
},
"valid": {
"type": "boolean"
},
"search": {
"type": "string"
},
"order_by": {
"type": "string"
},
"condition": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
},
"scheduled_before_pro_release": {
"type": "boolean"
},
"multi_step_before_pro_release": {
"type": "boolean"
}
}
}
}
WorkflowsUpdateWorkflowResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
}
}
}