{ "openapi": "3.1.1", "info": { "title": "EspoCRM API", "version": "1.0.0" }, "paths": { "\/Account": { "post": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Account_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "description": "Create a new Account record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Account" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "Account" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "customers", "resellers", "partners", "recentlyCreated" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "website", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "type", "industry", "sicCode", "contactRole", "contactIsInactive", "billingAddressStreet", "billingAddressCity", "billingAddressState", "billingAddressCountry", "billingAddressPostalCode", "shippingAddressStreet", "shippingAddressCity", "shippingAddressState", "shippingAddressCountry", "shippingAddressPostalCode", "description", "campaignId", "campaignName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "targetListsIds", "targetListsNames", "targetListId", "targetListName", "originalLeadId", "originalLeadName", "targetListIsOptedOut", "billingAddressMap", "shippingAddressMap", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List Account records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Account" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Account\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Account" ], "description": "Read an existing Account record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Account" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Account" } } } }, "parameters": [ { "in": "header", "name": "X-Version-Number", "schema": { "type": "string" }, "description": "A version number for optimistic concurrency control. Obtained from the 'versionNumber' field." } ], "description": "Update an existing Account record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Account" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "Account" ], "description": "Remove an existing Account record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Account\/{id}\/calls": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Account" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "planned", "held", "todays" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "dateStart", "dateEnd", "duration", "reminders", "direction", "description", "parentId", "parentType", "parentName", "accountId", "accountName", "uid", "acceptanceStatus", "usersIds", "usersColumns", "usersNames", "contactsIds", "contactsColumns", "contactsNames", "leadsIds", "leadsColumns", "leadsNames", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "phoneNumbersMap", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Call' records related through the 'calls' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Call" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Call record." } } } } } }, "description": "Relate 'Call' record though the 'calls' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Call record." } } } } } }, "description": "Unrelate 'Call' record related though the 'calls' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Account\/{id}\/callsPrimary": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Account" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "planned", "held", "todays" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "dateStart", "dateEnd", "duration", "reminders", "direction", "description", "parentId", "parentType", "parentName", "accountId", "accountName", "uid", "acceptanceStatus", "usersIds", "usersColumns", "usersNames", "contactsIds", "contactsColumns", "contactsNames", "leadsIds", "leadsColumns", "leadsNames", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "phoneNumbersMap", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Call' records related through the 'callsPrimary' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Call" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Call record." } } } } } }, "description": "Relate 'Call' record though the 'callsPrimary' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Call record." } } } } } }, "description": "Unrelate 'Call' record related though the 'callsPrimary' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Account\/{id}\/cases": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Account" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "open", "closed" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "number", "status", "priority", "type", "description", "accountId", "accountName", "leadId", "leadName", "contactId", "contactName", "contactsIds", "contactsNames", "inboundEmailId", "inboundEmailName", "originalEmailId", "originalEmailName", "isInternal", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Case' records related through the 'cases' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Case" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Case record." } } } } } }, "description": "Relate 'Case' record though the 'cases' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Case record." } } } } } }, "description": "Unrelate 'Case' record related though the 'cases' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Account\/{id}\/contacts": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Account" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "portalUsers", "notPortalUsers", "accountActive" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "salutationName", "firstName", "lastName", "middleName", "name", "accountAnyId", "title", "description", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "doNotCall", "addressStreet", "addressCity", "addressState", "addressCountry", "addressPostalCode", "accountId", "accountName", "accountsIds", "accountsColumns", "accountsNames", "accountRole", "accountIsInactive", "accountType", "opportunityRole", "acceptanceStatus", "acceptanceStatusMeetings", "acceptanceStatusCalls", "campaignId", "campaignName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "targetListsIds", "targetListsNames", "targetListId", "targetListName", "portalUserId", "portalUserName", "hasPortalUser", "originalLeadId", "originalLeadName", "targetListIsOptedOut", "originalEmailId", "originalEmailName", "addressMap", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Contact' records related through the 'contacts' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Contact" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Contact record." } } } } } }, "description": "Relate 'Contact' record though the 'contacts' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Contact record." } } } } } }, "description": "Unrelate 'Contact' record related though the 'contacts' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Account\/{id}\/contactsPrimary": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Account" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "portalUsers", "notPortalUsers", "accountActive" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "salutationName", "firstName", "lastName", "middleName", "name", "accountAnyId", "title", "description", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "doNotCall", "addressStreet", "addressCity", "addressState", "addressCountry", "addressPostalCode", "accountId", "accountName", "accountsIds", "accountsColumns", "accountsNames", "accountRole", "accountIsInactive", "accountType", "opportunityRole", "acceptanceStatus", "acceptanceStatusMeetings", "acceptanceStatusCalls", "campaignId", "campaignName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "targetListsIds", "targetListsNames", "targetListId", "targetListName", "portalUserId", "portalUserName", "hasPortalUser", "originalLeadId", "originalLeadName", "targetListIsOptedOut", "originalEmailId", "originalEmailName", "addressMap", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Contact' records related through the 'contactsPrimary' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Contact" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Contact record." } } } } } }, "description": "Relate 'Contact' record though the 'contactsPrimary' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Contact record." } } } } } }, "description": "Unrelate 'Contact' record related though the 'contactsPrimary' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Account\/{id}\/documents": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Account" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "active", "draft" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "fileId", "fileName", "status", "type", "publishDate", "expirationDate", "description", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "accountsIds", "accountsNames", "folderId", "folderName" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Document' records related through the 'documents' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Document" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Document record." } } } } } }, "description": "Relate 'Document' record though the 'documents' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Document record." } } } } } }, "description": "Unrelate 'Document' record related though the 'documents' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Account\/{id}\/emails": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Account" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "subject", "fromName", "fromAddress", "fromString", "replyToString", "replyToName", "replyToAddress", "addressNameMap", "from", "to", "cc", "bcc", "replyTo", "personStringData", "isRead", "isNotRead", "isReplied", "isNotReplied", "isImportant", "inTrash", "inArchive", "folderId", "isUsers", "isUsersSent", "folderName", "folderStringId", "folderStringName", "nameHash", "typeHash", "idHash", "messageId", "messageIdInternal", "emailAddress", "fromEmailAddressId", "fromEmailAddressName", "toEmailAddressesIds", "toEmailAddressesNames", "ccEmailAddressesIds", "ccEmailAddressesNames", "bccEmailAddressesIds", "bccEmailAddressesNames", "replyToEmailAddressesIds", "replyToEmailAddressesNames", "bodyPlain", "body", "isHtml", "status", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "hasAttachment", "parentId", "parentType", "parentName", "dateSent", "deliveryDate", "sendAt", "isAutoReply", "createdAt", "modifiedAt", "createdById", "createdByName", "sentById", "sentByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "repliedId", "repliedName", "repliesIds", "repliesNames", "isSystem", "isJustSent", "isBeingImported", "skipNotificationMap", "teamsIds", "teamsNames", "usersIds", "usersColumns", "usersNames", "assignedUsersIds", "assignedUsersNames", "inboundEmailsIds", "inboundEmailsNames", "emailAccountsIds", "emailAccountsNames", "icsContents", "icsEventData", "icsEventUid", "icsEventDateStart", "icsEventDateStartDate", "createEvent", "createdEventId", "createdEventType", "createdEventName", "groupFolderId", "groupFolderName", "groupStatusFolder", "accountId", "accountName", "tasksIds", "tasksNames" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Email' records related through the 'emails' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Email" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Email record." } } } } } }, "description": "Relate 'Email' record though the 'emails' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Email record." } } } } } }, "description": "Unrelate 'Email' record related though the 'emails' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Account\/{id}\/emailsPrimary": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Account" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "subject", "fromName", "fromAddress", "fromString", "replyToString", "replyToName", "replyToAddress", "addressNameMap", "from", "to", "cc", "bcc", "replyTo", "personStringData", "isRead", "isNotRead", "isReplied", "isNotReplied", "isImportant", "inTrash", "inArchive", "folderId", "isUsers", "isUsersSent", "folderName", "folderStringId", "folderStringName", "nameHash", "typeHash", "idHash", "messageId", "messageIdInternal", "emailAddress", "fromEmailAddressId", "fromEmailAddressName", "toEmailAddressesIds", "toEmailAddressesNames", "ccEmailAddressesIds", "ccEmailAddressesNames", "bccEmailAddressesIds", "bccEmailAddressesNames", "replyToEmailAddressesIds", "replyToEmailAddressesNames", "bodyPlain", "body", "isHtml", "status", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "hasAttachment", "parentId", "parentType", "parentName", "dateSent", "deliveryDate", "sendAt", "isAutoReply", "createdAt", "modifiedAt", "createdById", "createdByName", "sentById", "sentByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "repliedId", "repliedName", "repliesIds", "repliesNames", "isSystem", "isJustSent", "isBeingImported", "skipNotificationMap", "teamsIds", "teamsNames", "usersIds", "usersColumns", "usersNames", "assignedUsersIds", "assignedUsersNames", "inboundEmailsIds", "inboundEmailsNames", "emailAccountsIds", "emailAccountsNames", "icsContents", "icsEventData", "icsEventUid", "icsEventDateStart", "icsEventDateStartDate", "createEvent", "createdEventId", "createdEventType", "createdEventName", "groupFolderId", "groupFolderName", "groupStatusFolder", "accountId", "accountName", "tasksIds", "tasksNames" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Email' records related through the 'emailsPrimary' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Email" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Email record." } } } } } }, "description": "Relate 'Email' record though the 'emailsPrimary' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Email record." } } } } } }, "description": "Unrelate 'Email' record related though the 'emailsPrimary' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Account\/{id}\/meetings": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Account" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "planned", "held", "todays" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "dateStart", "dateStartDate", "dateEnd", "dateEndDate", "isAllDay", "duration", "reminders", "description", "parentId", "parentType", "parentName", "accountId", "accountName", "uid", "joinUrl", "acceptanceStatus", "usersIds", "usersColumns", "usersNames", "contactsIds", "contactsColumns", "contactsNames", "leadsIds", "leadsColumns", "leadsNames", "sourceEmailId", "sourceEmailName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Meeting' records related through the 'meetings' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Meeting" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Meeting record." } } } } } }, "description": "Relate 'Meeting' record though the 'meetings' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Meeting record." } } } } } }, "description": "Unrelate 'Meeting' record related though the 'meetings' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Account\/{id}\/meetingsPrimary": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Account" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "planned", "held", "todays" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "dateStart", "dateStartDate", "dateEnd", "dateEndDate", "isAllDay", "duration", "reminders", "description", "parentId", "parentType", "parentName", "accountId", "accountName", "uid", "joinUrl", "acceptanceStatus", "usersIds", "usersColumns", "usersNames", "contactsIds", "contactsColumns", "contactsNames", "leadsIds", "leadsColumns", "leadsNames", "sourceEmailId", "sourceEmailName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Meeting' records related through the 'meetingsPrimary' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Meeting" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Meeting record." } } } } } }, "description": "Relate 'Meeting' record though the 'meetingsPrimary' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Meeting record." } } } } } }, "description": "Unrelate 'Meeting' record related though the 'meetingsPrimary' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Account\/{id}\/opportunities": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Account" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "open", "won", "lost" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "amountCurrency", "amount", "amountConverted", "amountWeightedConverted", "accountId", "accountName", "contactsIds", "contactsColumns", "contactsNames", "contactId", "contactName", "stage", "lastStage", "probability", "leadSource", "closeDate", "description", "campaignId", "campaignName", "originalLeadId", "originalLeadName", "contactRole", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Opportunity' records related through the 'opportunities' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Opportunity" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Opportunity record." } } } } } }, "description": "Relate 'Opportunity' record though the 'opportunities' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Opportunity record." } } } } } }, "description": "Unrelate 'Opportunity' record related though the 'opportunities' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Account\/{id}\/portalUsers": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Account" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "active", "activePortal", "activeApi", "portal", "api", "internal" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMyTeam" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "userName", "salutationName", "firstName", "lastName", "middleName", "name", "type", "authMethod", "apiKey", "secretKey", "isActive", "title", "position", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "token", "authTokenId", "ipAddress", "defaultTeamId", "defaultTeamName", "acceptanceStatus", "acceptanceStatusMeetings", "acceptanceStatusCalls", "teamRole", "teamsIds", "teamsColumns", "teamsNames", "rolesIds", "rolesNames", "portalsIds", "portalsNames", "portalRolesIds", "portalRolesNames", "contactId", "contactName", "accountsIds", "accountsNames", "accountId", "accountName", "portalId", "portalName", "avatarId", "avatarName", "avatarColor", "sendAccessInfo", "gender", "createdAt", "modifiedAt", "createdById", "createdByName", "dashboardTemplateId", "dashboardTemplateName", "workingTimeCalendarId", "workingTimeCalendarName", "layoutSetId", "layoutSetName", "auth2FA", "lastAccess", "emailAddressList", "userEmailAddressList", "excludeFromReplyEmailAddressList", "recordAccessLevels", "targetListIsOptedOut" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'User' records related through the 'portalUsers' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/User" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of User record." } } } } } }, "description": "Relate 'User' record though the 'portalUsers' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of User record." } } } } } }, "description": "Unrelate 'User' record related though the 'portalUsers' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Account\/{id}\/targetLists": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Account" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "categoryId", "categoryName", "entryCount", "optedOutCount", "description", "sourceCampaignId", "sourceCampaignName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "includingActionList", "excludingActionList", "targetStatus", "isOptedOut" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'TargetList' records related through the 'targetLists' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TargetList" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of TargetList record." } } } } } }, "description": "Relate 'TargetList' record though the 'targetLists' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of TargetList record." } } } } } }, "description": "Unrelate 'TargetList' record related though the 'targetLists' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Account\/{id}\/tasks": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Account" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "actual", "completed", "deferred", "todays", "actualStartingNotInFuture", "overdue" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "priority", "dateStart", "dateStartDate", "dateEnd", "dateEndDate", "dateCompleted", "isOverdue", "reminders", "description", "parentId", "parentType", "parentName", "accountId", "accountName", "contactId", "contactName", "originalEmailId", "originalEmailName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Task' records related through the 'tasks' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Task" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Task record." } } } } } }, "description": "Relate 'Task' record though the 'tasks' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Task record." } } } } } }, "description": "Unrelate 'Task' record related though the 'tasks' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Account\/{id}\/tasksPrimary": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Account" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "actual", "completed", "deferred", "todays", "actualStartingNotInFuture", "overdue" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "priority", "dateStart", "dateStartDate", "dateEnd", "dateEndDate", "dateCompleted", "isOverdue", "reminders", "description", "parentId", "parentType", "parentName", "accountId", "accountName", "contactId", "contactName", "originalEmailId", "originalEmailName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Task' records related through the 'tasksPrimary' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Task" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Task record." } } } } } }, "description": "Relate 'Task' record though the 'tasksPrimary' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Task record." } } } } } }, "description": "Unrelate 'Task' record related though the 'tasksPrimary' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Call": { "post": { "tags": [ "Call" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Call_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "description": "Create a new Call record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Call" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "Call" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "planned", "held", "todays" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "dateStart", "dateEnd", "duration", "reminders", "direction", "description", "parentId", "parentType", "parentName", "accountId", "accountName", "uid", "acceptanceStatus", "usersIds", "usersColumns", "usersNames", "contactsIds", "contactsColumns", "contactsNames", "leadsIds", "leadsColumns", "leadsNames", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "phoneNumbersMap", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List Call records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Call" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Call\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Call" ], "description": "Read an existing Call record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Call" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "Call" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Call" } } } }, "parameters": [], "description": "Update an existing Call record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Call" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "Call" ], "description": "Remove an existing Call record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Call\/{id}\/contacts": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Call" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "portalUsers", "notPortalUsers", "accountActive" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "salutationName", "firstName", "lastName", "middleName", "name", "accountAnyId", "title", "description", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "doNotCall", "addressStreet", "addressCity", "addressState", "addressCountry", "addressPostalCode", "accountId", "accountName", "accountsIds", "accountsColumns", "accountsNames", "accountRole", "accountIsInactive", "accountType", "opportunityRole", "acceptanceStatus", "acceptanceStatusMeetings", "acceptanceStatusCalls", "campaignId", "campaignName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "targetListsIds", "targetListsNames", "targetListId", "targetListName", "portalUserId", "portalUserName", "hasPortalUser", "originalLeadId", "originalLeadName", "targetListIsOptedOut", "originalEmailId", "originalEmailName", "addressMap", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Contact' records related through the 'contacts' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Contact" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Call" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Contact record." } } } } } }, "description": "Relate 'Contact' record though the 'contacts' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Call" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Contact record." } } } } } }, "description": "Unrelate 'Contact' record related though the 'contacts' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Call\/{id}\/leads": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Call" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "actual", "active", "converted" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "salutationName", "firstName", "lastName", "middleName", "name", "title", "status", "source", "industry", "opportunityAmountCurrency", "opportunityAmount", "opportunityAmountConverted", "website", "addressStreet", "addressCity", "addressState", "addressCountry", "addressPostalCode", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "doNotCall", "description", "convertedAt", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "accountName", "assignedUserId", "assignedUserName", "acceptanceStatus", "acceptanceStatusMeetings", "acceptanceStatusCalls", "teamsIds", "teamsNames", "campaignId", "campaignName", "createdAccountId", "createdAccountName", "createdContactId", "createdContactName", "createdOpportunityId", "createdOpportunityName", "targetListsIds", "targetListsNames", "targetListId", "targetListName", "targetListIsOptedOut", "originalEmailId", "originalEmailName", "addressMap", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Lead' records related through the 'leads' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Lead" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Call" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Lead record." } } } } } }, "description": "Relate 'Lead' record though the 'leads' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Call" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Lead record." } } } } } }, "description": "Unrelate 'Lead' record related though the 'leads' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Call\/{id}\/users": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Call" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "active", "activePortal", "activeApi", "portal", "api", "internal" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMyTeam" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "userName", "salutationName", "firstName", "lastName", "middleName", "name", "type", "authMethod", "apiKey", "secretKey", "isActive", "title", "position", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "token", "authTokenId", "ipAddress", "defaultTeamId", "defaultTeamName", "acceptanceStatus", "acceptanceStatusMeetings", "acceptanceStatusCalls", "teamRole", "teamsIds", "teamsColumns", "teamsNames", "rolesIds", "rolesNames", "portalsIds", "portalsNames", "portalRolesIds", "portalRolesNames", "contactId", "contactName", "accountsIds", "accountsNames", "accountId", "accountName", "portalId", "portalName", "avatarId", "avatarName", "avatarColor", "sendAccessInfo", "gender", "createdAt", "modifiedAt", "createdById", "createdByName", "dashboardTemplateId", "dashboardTemplateName", "workingTimeCalendarId", "workingTimeCalendarName", "layoutSetId", "layoutSetName", "auth2FA", "lastAccess", "emailAddressList", "userEmailAddressList", "excludeFromReplyEmailAddressList", "recordAccessLevels", "targetListIsOptedOut" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'User' records related through the 'users' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/User" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Call" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of User record." } } } } } }, "description": "Relate 'User' record though the 'users' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Call" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of User record." } } } } } }, "description": "Unrelate 'User' record related though the 'users' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Campaign": { "post": { "tags": [ "Campaign" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Campaign_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "description": "Create a new Campaign record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Campaign" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "Campaign" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "active" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "type", "startDate", "endDate", "description", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "targetListsIds", "targetListsNames", "excludingTargetListsIds", "excludingTargetListsNames", "sentCount", "openedCount", "clickedCount", "optedInCount", "optedOutCount", "bouncedCount", "hardBouncedCount", "softBouncedCount", "leadCreatedCount", "openedPercentage", "clickedPercentage", "optedOutPercentage", "bouncedPercentage", "revenueCurrency", "revenue", "budgetCurrency", "budget", "contactsTemplateId", "contactsTemplateName", "leadsTemplateId", "leadsTemplateName", "accountsTemplateId", "accountsTemplateName", "usersTemplateId", "usersTemplateName", "mailMergeOnlyWithAddress", "revenueConverted", "budgetConverted" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List Campaign records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Campaign" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Campaign\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Campaign" ], "description": "Read an existing Campaign record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Campaign" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "Campaign" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Campaign" } } } }, "parameters": [], "description": "Update an existing Campaign record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Campaign" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "Campaign" ], "description": "Remove an existing Campaign record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Campaign\/{id}\/accounts": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Campaign" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "customers", "resellers", "partners", "recentlyCreated" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "website", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "type", "industry", "sicCode", "contactRole", "contactIsInactive", "billingAddressStreet", "billingAddressCity", "billingAddressState", "billingAddressCountry", "billingAddressPostalCode", "shippingAddressStreet", "shippingAddressCity", "shippingAddressState", "shippingAddressCountry", "shippingAddressPostalCode", "description", "campaignId", "campaignName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "targetListsIds", "targetListsNames", "targetListId", "targetListName", "originalLeadId", "originalLeadName", "targetListIsOptedOut", "billingAddressMap", "shippingAddressMap", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Account' records related through the 'accounts' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Account" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Campaign" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Account record." } } } } } }, "description": "Relate 'Account' record though the 'accounts' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Campaign" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Account record." } } } } } }, "description": "Unrelate 'Account' record related though the 'accounts' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Campaign\/{id}\/contacts": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Campaign" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "portalUsers", "notPortalUsers", "accountActive" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "salutationName", "firstName", "lastName", "middleName", "name", "accountAnyId", "title", "description", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "doNotCall", "addressStreet", "addressCity", "addressState", "addressCountry", "addressPostalCode", "accountId", "accountName", "accountsIds", "accountsColumns", "accountsNames", "accountRole", "accountIsInactive", "accountType", "opportunityRole", "acceptanceStatus", "acceptanceStatusMeetings", "acceptanceStatusCalls", "campaignId", "campaignName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "targetListsIds", "targetListsNames", "targetListId", "targetListName", "portalUserId", "portalUserName", "hasPortalUser", "originalLeadId", "originalLeadName", "targetListIsOptedOut", "originalEmailId", "originalEmailName", "addressMap", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Contact' records related through the 'contacts' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Contact" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Campaign" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Contact record." } } } } } }, "description": "Relate 'Contact' record though the 'contacts' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Campaign" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Contact record." } } } } } }, "description": "Unrelate 'Contact' record related though the 'contacts' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Campaign\/{id}\/excludingTargetLists": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Campaign" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "categoryId", "categoryName", "entryCount", "optedOutCount", "description", "sourceCampaignId", "sourceCampaignName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "includingActionList", "excludingActionList", "targetStatus", "isOptedOut" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'TargetList' records related through the 'excludingTargetLists' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TargetList" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Campaign" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of TargetList record." } } } } } }, "description": "Relate 'TargetList' record though the 'excludingTargetLists' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Campaign" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of TargetList record." } } } } } }, "description": "Unrelate 'TargetList' record related though the 'excludingTargetLists' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Campaign\/{id}\/leads": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Campaign" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "actual", "active", "converted" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "salutationName", "firstName", "lastName", "middleName", "name", "title", "status", "source", "industry", "opportunityAmountCurrency", "opportunityAmount", "opportunityAmountConverted", "website", "addressStreet", "addressCity", "addressState", "addressCountry", "addressPostalCode", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "doNotCall", "description", "convertedAt", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "accountName", "assignedUserId", "assignedUserName", "acceptanceStatus", "acceptanceStatusMeetings", "acceptanceStatusCalls", "teamsIds", "teamsNames", "campaignId", "campaignName", "createdAccountId", "createdAccountName", "createdContactId", "createdContactName", "createdOpportunityId", "createdOpportunityName", "targetListsIds", "targetListsNames", "targetListId", "targetListName", "targetListIsOptedOut", "originalEmailId", "originalEmailName", "addressMap", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Lead' records related through the 'leads' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Lead" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Campaign" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Lead record." } } } } } }, "description": "Relate 'Lead' record though the 'leads' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Campaign" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Lead record." } } } } } }, "description": "Unrelate 'Lead' record related though the 'leads' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Campaign\/{id}\/opportunities": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Campaign" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "open", "won", "lost" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "amountCurrency", "amount", "amountConverted", "amountWeightedConverted", "accountId", "accountName", "contactsIds", "contactsColumns", "contactsNames", "contactId", "contactName", "stage", "lastStage", "probability", "leadSource", "closeDate", "description", "campaignId", "campaignName", "originalLeadId", "originalLeadName", "contactRole", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Opportunity' records related through the 'opportunities' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Opportunity" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Campaign" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Opportunity record." } } } } } }, "description": "Relate 'Opportunity' record though the 'opportunities' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Campaign" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Opportunity record." } } } } } }, "description": "Unrelate 'Opportunity' record related though the 'opportunities' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Campaign\/{id}\/targetLists": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Campaign" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "categoryId", "categoryName", "entryCount", "optedOutCount", "description", "sourceCampaignId", "sourceCampaignName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "includingActionList", "excludingActionList", "targetStatus", "isOptedOut" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'TargetList' records related through the 'targetLists' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TargetList" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Campaign" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of TargetList record." } } } } } }, "description": "Relate 'TargetList' record though the 'targetLists' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Campaign" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of TargetList record." } } } } } }, "description": "Unrelate 'TargetList' record related though the 'targetLists' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Case": { "post": { "tags": [ "Case" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Case_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "description": "Create a new Case record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Case" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "Case" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "open", "closed" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "number", "status", "priority", "type", "description", "accountId", "accountName", "leadId", "leadName", "contactId", "contactName", "contactsIds", "contactsNames", "inboundEmailId", "inboundEmailName", "originalEmailId", "originalEmailName", "isInternal", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List Case records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Case" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Case\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Case" ], "description": "Read an existing Case record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Case" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "Case" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Case" } } } }, "parameters": [ { "in": "header", "name": "X-Version-Number", "schema": { "type": "string" }, "description": "A version number for optimistic concurrency control. Obtained from the 'versionNumber' field." } ], "description": "Update an existing Case record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Case" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "Case" ], "description": "Remove an existing Case record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Case\/{id}\/articles": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Case" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "published" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "language", "type", "portalsIds", "portalsNames", "publishDate", "expirationDate", "order", "description", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "categoriesIds", "categoriesNames", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "body", "bodyPlain" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'KnowledgeBaseArticle' records related through the 'articles' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/KnowledgeBaseArticle" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Case" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of KnowledgeBaseArticle record." } } } } } }, "description": "Relate 'KnowledgeBaseArticle' record though the 'articles' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Case" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of KnowledgeBaseArticle record." } } } } } }, "description": "Unrelate 'KnowledgeBaseArticle' record related though the 'articles' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Case\/{id}\/calls": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Case" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "planned", "held", "todays" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "dateStart", "dateEnd", "duration", "reminders", "direction", "description", "parentId", "parentType", "parentName", "accountId", "accountName", "uid", "acceptanceStatus", "usersIds", "usersColumns", "usersNames", "contactsIds", "contactsColumns", "contactsNames", "leadsIds", "leadsColumns", "leadsNames", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "phoneNumbersMap", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Call' records related through the 'calls' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Call" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Case" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Call record." } } } } } }, "description": "Relate 'Call' record though the 'calls' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Case" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Call record." } } } } } }, "description": "Unrelate 'Call' record related though the 'calls' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Case\/{id}\/contacts": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Case" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "portalUsers", "notPortalUsers", "accountActive" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "salutationName", "firstName", "lastName", "middleName", "name", "accountAnyId", "title", "description", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "doNotCall", "addressStreet", "addressCity", "addressState", "addressCountry", "addressPostalCode", "accountId", "accountName", "accountsIds", "accountsColumns", "accountsNames", "accountRole", "accountIsInactive", "accountType", "opportunityRole", "acceptanceStatus", "acceptanceStatusMeetings", "acceptanceStatusCalls", "campaignId", "campaignName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "targetListsIds", "targetListsNames", "targetListId", "targetListName", "portalUserId", "portalUserName", "hasPortalUser", "originalLeadId", "originalLeadName", "targetListIsOptedOut", "originalEmailId", "originalEmailName", "addressMap", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Contact' records related through the 'contacts' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Contact" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Case" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Contact record." } } } } } }, "description": "Relate 'Contact' record though the 'contacts' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Case" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Contact record." } } } } } }, "description": "Unrelate 'Contact' record related though the 'contacts' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Case\/{id}\/emails": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Case" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "subject", "fromName", "fromAddress", "fromString", "replyToString", "replyToName", "replyToAddress", "addressNameMap", "from", "to", "cc", "bcc", "replyTo", "personStringData", "isRead", "isNotRead", "isReplied", "isNotReplied", "isImportant", "inTrash", "inArchive", "folderId", "isUsers", "isUsersSent", "folderName", "folderStringId", "folderStringName", "nameHash", "typeHash", "idHash", "messageId", "messageIdInternal", "emailAddress", "fromEmailAddressId", "fromEmailAddressName", "toEmailAddressesIds", "toEmailAddressesNames", "ccEmailAddressesIds", "ccEmailAddressesNames", "bccEmailAddressesIds", "bccEmailAddressesNames", "replyToEmailAddressesIds", "replyToEmailAddressesNames", "bodyPlain", "body", "isHtml", "status", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "hasAttachment", "parentId", "parentType", "parentName", "dateSent", "deliveryDate", "sendAt", "isAutoReply", "createdAt", "modifiedAt", "createdById", "createdByName", "sentById", "sentByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "repliedId", "repliedName", "repliesIds", "repliesNames", "isSystem", "isJustSent", "isBeingImported", "skipNotificationMap", "teamsIds", "teamsNames", "usersIds", "usersColumns", "usersNames", "assignedUsersIds", "assignedUsersNames", "inboundEmailsIds", "inboundEmailsNames", "emailAccountsIds", "emailAccountsNames", "icsContents", "icsEventData", "icsEventUid", "icsEventDateStart", "icsEventDateStartDate", "createEvent", "createdEventId", "createdEventType", "createdEventName", "groupFolderId", "groupFolderName", "groupStatusFolder", "accountId", "accountName", "tasksIds", "tasksNames" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Email' records related through the 'emails' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Email" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Case" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Email record." } } } } } }, "description": "Relate 'Email' record though the 'emails' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Case" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Email record." } } } } } }, "description": "Unrelate 'Email' record related though the 'emails' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Case\/{id}\/meetings": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Case" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "planned", "held", "todays" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "dateStart", "dateStartDate", "dateEnd", "dateEndDate", "isAllDay", "duration", "reminders", "description", "parentId", "parentType", "parentName", "accountId", "accountName", "uid", "joinUrl", "acceptanceStatus", "usersIds", "usersColumns", "usersNames", "contactsIds", "contactsColumns", "contactsNames", "leadsIds", "leadsColumns", "leadsNames", "sourceEmailId", "sourceEmailName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Meeting' records related through the 'meetings' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Meeting" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Case" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Meeting record." } } } } } }, "description": "Relate 'Meeting' record though the 'meetings' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Case" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Meeting record." } } } } } }, "description": "Unrelate 'Meeting' record related though the 'meetings' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Case\/{id}\/tasks": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Case" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "actual", "completed", "deferred", "todays", "actualStartingNotInFuture", "overdue" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "priority", "dateStart", "dateStartDate", "dateEnd", "dateEndDate", "dateCompleted", "isOverdue", "reminders", "description", "parentId", "parentType", "parentName", "accountId", "accountName", "contactId", "contactName", "originalEmailId", "originalEmailName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Task' records related through the 'tasks' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Task" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Case" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Task record." } } } } } }, "description": "Relate 'Task' record though the 'tasks' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Case" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Task record." } } } } } }, "description": "Unrelate 'Task' record related though the 'tasks' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Contact": { "post": { "tags": [ "Contact" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Contact_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "description": "Create a new Contact record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Contact" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "Contact" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "portalUsers", "notPortalUsers", "accountActive" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "salutationName", "firstName", "lastName", "middleName", "name", "accountAnyId", "title", "description", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "doNotCall", "addressStreet", "addressCity", "addressState", "addressCountry", "addressPostalCode", "accountId", "accountName", "accountsIds", "accountsColumns", "accountsNames", "accountRole", "accountIsInactive", "accountType", "opportunityRole", "acceptanceStatus", "acceptanceStatusMeetings", "acceptanceStatusCalls", "campaignId", "campaignName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "targetListsIds", "targetListsNames", "targetListId", "targetListName", "portalUserId", "portalUserName", "hasPortalUser", "originalLeadId", "originalLeadName", "targetListIsOptedOut", "originalEmailId", "originalEmailName", "addressMap", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List Contact records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Contact" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Contact\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Contact" ], "description": "Read an existing Contact record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Contact" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "Contact" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Contact" } } } }, "parameters": [], "description": "Update an existing Contact record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Contact" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "Contact" ], "description": "Remove an existing Contact record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Contact\/{id}\/accounts": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Contact" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "customers", "resellers", "partners", "recentlyCreated" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "website", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "type", "industry", "sicCode", "contactRole", "contactIsInactive", "billingAddressStreet", "billingAddressCity", "billingAddressState", "billingAddressCountry", "billingAddressPostalCode", "shippingAddressStreet", "shippingAddressCity", "shippingAddressState", "shippingAddressCountry", "shippingAddressPostalCode", "description", "campaignId", "campaignName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "targetListsIds", "targetListsNames", "targetListId", "targetListName", "originalLeadId", "originalLeadName", "targetListIsOptedOut", "billingAddressMap", "shippingAddressMap", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Account' records related through the 'accounts' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Account" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Contact" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Account record." } } } } } }, "description": "Relate 'Account' record though the 'accounts' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Contact" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Account record." } } } } } }, "description": "Unrelate 'Account' record related though the 'accounts' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Contact\/{id}\/calls": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Contact" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "planned", "held", "todays" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "dateStart", "dateEnd", "duration", "reminders", "direction", "description", "parentId", "parentType", "parentName", "accountId", "accountName", "uid", "acceptanceStatus", "usersIds", "usersColumns", "usersNames", "contactsIds", "contactsColumns", "contactsNames", "leadsIds", "leadsColumns", "leadsNames", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "phoneNumbersMap", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Call' records related through the 'calls' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Call" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Contact" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Call record." } } } } } }, "description": "Relate 'Call' record though the 'calls' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Contact" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Call record." } } } } } }, "description": "Unrelate 'Call' record related though the 'calls' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Contact\/{id}\/cases": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Contact" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "open", "closed" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "number", "status", "priority", "type", "description", "accountId", "accountName", "leadId", "leadName", "contactId", "contactName", "contactsIds", "contactsNames", "inboundEmailId", "inboundEmailName", "originalEmailId", "originalEmailName", "isInternal", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Case' records related through the 'cases' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Case" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Contact" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Case record." } } } } } }, "description": "Relate 'Case' record though the 'cases' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Contact" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Case record." } } } } } }, "description": "Unrelate 'Case' record related though the 'cases' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Contact\/{id}\/casesPrimary": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Contact" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "open", "closed" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "number", "status", "priority", "type", "description", "accountId", "accountName", "leadId", "leadName", "contactId", "contactName", "contactsIds", "contactsNames", "inboundEmailId", "inboundEmailName", "originalEmailId", "originalEmailName", "isInternal", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Case' records related through the 'casesPrimary' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Case" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Contact" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Case record." } } } } } }, "description": "Relate 'Case' record though the 'casesPrimary' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Contact" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Case record." } } } } } }, "description": "Unrelate 'Case' record related though the 'casesPrimary' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Contact\/{id}\/documents": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Contact" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "active", "draft" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "fileId", "fileName", "status", "type", "publishDate", "expirationDate", "description", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "accountsIds", "accountsNames", "folderId", "folderName" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Document' records related through the 'documents' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Document" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Contact" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Document record." } } } } } }, "description": "Relate 'Document' record though the 'documents' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Contact" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Document record." } } } } } }, "description": "Unrelate 'Document' record related though the 'documents' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Contact\/{id}\/emails": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Contact" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "subject", "fromName", "fromAddress", "fromString", "replyToString", "replyToName", "replyToAddress", "addressNameMap", "from", "to", "cc", "bcc", "replyTo", "personStringData", "isRead", "isNotRead", "isReplied", "isNotReplied", "isImportant", "inTrash", "inArchive", "folderId", "isUsers", "isUsersSent", "folderName", "folderStringId", "folderStringName", "nameHash", "typeHash", "idHash", "messageId", "messageIdInternal", "emailAddress", "fromEmailAddressId", "fromEmailAddressName", "toEmailAddressesIds", "toEmailAddressesNames", "ccEmailAddressesIds", "ccEmailAddressesNames", "bccEmailAddressesIds", "bccEmailAddressesNames", "replyToEmailAddressesIds", "replyToEmailAddressesNames", "bodyPlain", "body", "isHtml", "status", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "hasAttachment", "parentId", "parentType", "parentName", "dateSent", "deliveryDate", "sendAt", "isAutoReply", "createdAt", "modifiedAt", "createdById", "createdByName", "sentById", "sentByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "repliedId", "repliedName", "repliesIds", "repliesNames", "isSystem", "isJustSent", "isBeingImported", "skipNotificationMap", "teamsIds", "teamsNames", "usersIds", "usersColumns", "usersNames", "assignedUsersIds", "assignedUsersNames", "inboundEmailsIds", "inboundEmailsNames", "emailAccountsIds", "emailAccountsNames", "icsContents", "icsEventData", "icsEventUid", "icsEventDateStart", "icsEventDateStartDate", "createEvent", "createdEventId", "createdEventType", "createdEventName", "groupFolderId", "groupFolderName", "groupStatusFolder", "accountId", "accountName", "tasksIds", "tasksNames" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Email' records related through the 'emails' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Email" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Contact" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Email record." } } } } } }, "description": "Relate 'Email' record though the 'emails' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Contact" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Email record." } } } } } }, "description": "Unrelate 'Email' record related though the 'emails' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Contact\/{id}\/meetings": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Contact" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "planned", "held", "todays" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "dateStart", "dateStartDate", "dateEnd", "dateEndDate", "isAllDay", "duration", "reminders", "description", "parentId", "parentType", "parentName", "accountId", "accountName", "uid", "joinUrl", "acceptanceStatus", "usersIds", "usersColumns", "usersNames", "contactsIds", "contactsColumns", "contactsNames", "leadsIds", "leadsColumns", "leadsNames", "sourceEmailId", "sourceEmailName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Meeting' records related through the 'meetings' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Meeting" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Contact" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Meeting record." } } } } } }, "description": "Relate 'Meeting' record though the 'meetings' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Contact" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Meeting record." } } } } } }, "description": "Unrelate 'Meeting' record related though the 'meetings' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Contact\/{id}\/opportunities": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Contact" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "open", "won", "lost" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "amountCurrency", "amount", "amountConverted", "amountWeightedConverted", "accountId", "accountName", "contactsIds", "contactsColumns", "contactsNames", "contactId", "contactName", "stage", "lastStage", "probability", "leadSource", "closeDate", "description", "campaignId", "campaignName", "originalLeadId", "originalLeadName", "contactRole", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Opportunity' records related through the 'opportunities' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Opportunity" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Contact" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Opportunity record." } } } } } }, "description": "Relate 'Opportunity' record though the 'opportunities' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Contact" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Opportunity record." } } } } } }, "description": "Unrelate 'Opportunity' record related though the 'opportunities' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Contact\/{id}\/opportunitiesPrimary": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Contact" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "open", "won", "lost" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "amountCurrency", "amount", "amountConverted", "amountWeightedConverted", "accountId", "accountName", "contactsIds", "contactsColumns", "contactsNames", "contactId", "contactName", "stage", "lastStage", "probability", "leadSource", "closeDate", "description", "campaignId", "campaignName", "originalLeadId", "originalLeadName", "contactRole", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Opportunity' records related through the 'opportunitiesPrimary' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Opportunity" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Contact" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Opportunity record." } } } } } }, "description": "Relate 'Opportunity' record though the 'opportunitiesPrimary' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Contact" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Opportunity record." } } } } } }, "description": "Unrelate 'Opportunity' record related though the 'opportunitiesPrimary' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Contact\/{id}\/targetLists": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Contact" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "categoryId", "categoryName", "entryCount", "optedOutCount", "description", "sourceCampaignId", "sourceCampaignName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "includingActionList", "excludingActionList", "targetStatus", "isOptedOut" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'TargetList' records related through the 'targetLists' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TargetList" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Contact" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of TargetList record." } } } } } }, "description": "Relate 'TargetList' record though the 'targetLists' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Contact" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of TargetList record." } } } } } }, "description": "Unrelate 'TargetList' record related though the 'targetLists' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Contact\/{id}\/tasks": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Contact" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "actual", "completed", "deferred", "todays", "actualStartingNotInFuture", "overdue" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "priority", "dateStart", "dateStartDate", "dateEnd", "dateEndDate", "dateCompleted", "isOverdue", "reminders", "description", "parentId", "parentType", "parentName", "accountId", "accountName", "contactId", "contactName", "originalEmailId", "originalEmailName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Task' records related through the 'tasks' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Task" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Contact" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Task record." } } } } } }, "description": "Relate 'Task' record though the 'tasks' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Contact" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Task record." } } } } } }, "description": "Unrelate 'Task' record related though the 'tasks' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Contact\/{id}\/tasksPrimary": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Contact" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "actual", "completed", "deferred", "todays", "actualStartingNotInFuture", "overdue" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "priority", "dateStart", "dateStartDate", "dateEnd", "dateEndDate", "dateCompleted", "isOverdue", "reminders", "description", "parentId", "parentType", "parentName", "accountId", "accountName", "contactId", "contactName", "originalEmailId", "originalEmailName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Task' records related through the 'tasksPrimary' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Task" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Contact" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Task record." } } } } } }, "description": "Relate 'Task' record though the 'tasksPrimary' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Contact" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Task record." } } } } } }, "description": "Unrelate 'Task' record related though the 'tasksPrimary' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Document": { "post": { "tags": [ "Document" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Document_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "description": "Create a new Document record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Document" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "Document" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "active", "draft" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "fileId", "fileName", "status", "type", "publishDate", "expirationDate", "description", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "accountsIds", "accountsNames", "folderId", "folderName" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List Document records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Document" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Document\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Document" ], "description": "Read an existing Document record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Document" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "Document" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Document" } } } }, "parameters": [], "description": "Update an existing Document record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Document" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "Document" ], "description": "Remove an existing Document record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Document\/{id}\/accounts": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Document" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "customers", "resellers", "partners", "recentlyCreated" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "website", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "type", "industry", "sicCode", "contactRole", "contactIsInactive", "billingAddressStreet", "billingAddressCity", "billingAddressState", "billingAddressCountry", "billingAddressPostalCode", "shippingAddressStreet", "shippingAddressCity", "shippingAddressState", "shippingAddressCountry", "shippingAddressPostalCode", "description", "campaignId", "campaignName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "targetListsIds", "targetListsNames", "targetListId", "targetListName", "originalLeadId", "originalLeadName", "targetListIsOptedOut", "billingAddressMap", "shippingAddressMap", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Account' records related through the 'accounts' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Account" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Document" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Account record." } } } } } }, "description": "Relate 'Account' record though the 'accounts' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Document" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Account record." } } } } } }, "description": "Unrelate 'Account' record related though the 'accounts' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Document\/{id}\/contacts": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Document" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "portalUsers", "notPortalUsers", "accountActive" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "salutationName", "firstName", "lastName", "middleName", "name", "accountAnyId", "title", "description", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "doNotCall", "addressStreet", "addressCity", "addressState", "addressCountry", "addressPostalCode", "accountId", "accountName", "accountsIds", "accountsColumns", "accountsNames", "accountRole", "accountIsInactive", "accountType", "opportunityRole", "acceptanceStatus", "acceptanceStatusMeetings", "acceptanceStatusCalls", "campaignId", "campaignName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "targetListsIds", "targetListsNames", "targetListId", "targetListName", "portalUserId", "portalUserName", "hasPortalUser", "originalLeadId", "originalLeadName", "targetListIsOptedOut", "originalEmailId", "originalEmailName", "addressMap", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Contact' records related through the 'contacts' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Contact" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Document" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Contact record." } } } } } }, "description": "Relate 'Contact' record though the 'contacts' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Document" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Contact record." } } } } } }, "description": "Unrelate 'Contact' record related though the 'contacts' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Document\/{id}\/leads": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Document" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "actual", "active", "converted" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "salutationName", "firstName", "lastName", "middleName", "name", "title", "status", "source", "industry", "opportunityAmountCurrency", "opportunityAmount", "opportunityAmountConverted", "website", "addressStreet", "addressCity", "addressState", "addressCountry", "addressPostalCode", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "doNotCall", "description", "convertedAt", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "accountName", "assignedUserId", "assignedUserName", "acceptanceStatus", "acceptanceStatusMeetings", "acceptanceStatusCalls", "teamsIds", "teamsNames", "campaignId", "campaignName", "createdAccountId", "createdAccountName", "createdContactId", "createdContactName", "createdOpportunityId", "createdOpportunityName", "targetListsIds", "targetListsNames", "targetListId", "targetListName", "targetListIsOptedOut", "originalEmailId", "originalEmailName", "addressMap", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Lead' records related through the 'leads' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Lead" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Document" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Lead record." } } } } } }, "description": "Relate 'Lead' record though the 'leads' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Document" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Lead record." } } } } } }, "description": "Unrelate 'Lead' record related though the 'leads' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Document\/{id}\/opportunities": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Document" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "open", "won", "lost" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "amountCurrency", "amount", "amountConverted", "amountWeightedConverted", "accountId", "accountName", "contactsIds", "contactsColumns", "contactsNames", "contactId", "contactName", "stage", "lastStage", "probability", "leadSource", "closeDate", "description", "campaignId", "campaignName", "originalLeadId", "originalLeadName", "contactRole", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Opportunity' records related through the 'opportunities' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Opportunity" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Document" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Opportunity record." } } } } } }, "description": "Relate 'Opportunity' record though the 'opportunities' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Document" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Opportunity record." } } } } } }, "description": "Unrelate 'Opportunity' record related though the 'opportunities' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Email": { "post": { "tags": [ "Email" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Email_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "description": "Create a new Email record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Email" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "Email" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "subject", "fromName", "fromAddress", "fromString", "replyToString", "replyToName", "replyToAddress", "addressNameMap", "from", "to", "cc", "bcc", "replyTo", "personStringData", "isRead", "isNotRead", "isReplied", "isNotReplied", "isImportant", "inTrash", "inArchive", "folderId", "isUsers", "isUsersSent", "folderName", "folderStringId", "folderStringName", "nameHash", "typeHash", "idHash", "messageId", "messageIdInternal", "emailAddress", "fromEmailAddressId", "fromEmailAddressName", "toEmailAddressesIds", "toEmailAddressesNames", "ccEmailAddressesIds", "ccEmailAddressesNames", "bccEmailAddressesIds", "bccEmailAddressesNames", "replyToEmailAddressesIds", "replyToEmailAddressesNames", "bodyPlain", "body", "isHtml", "status", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "hasAttachment", "parentId", "parentType", "parentName", "dateSent", "deliveryDate", "sendAt", "isAutoReply", "createdAt", "modifiedAt", "createdById", "createdByName", "sentById", "sentByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "repliedId", "repliedName", "repliesIds", "repliesNames", "isSystem", "isJustSent", "isBeingImported", "skipNotificationMap", "teamsIds", "teamsNames", "usersIds", "usersColumns", "usersNames", "assignedUsersIds", "assignedUsersNames", "inboundEmailsIds", "inboundEmailsNames", "emailAccountsIds", "emailAccountsNames", "icsContents", "icsEventData", "icsEventUid", "icsEventDateStart", "icsEventDateStartDate", "createEvent", "createdEventId", "createdEventType", "createdEventName", "groupFolderId", "groupFolderName", "groupStatusFolder", "accountId", "accountName", "tasksIds", "tasksNames" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List Email records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Email" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Email\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Email" ], "description": "Read an existing Email record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Email" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "Email" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Email" } } } }, "parameters": [], "description": "Update an existing Email record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Email" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "Email" ], "description": "Remove an existing Email record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Email\/{id}\/assignedUsers": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Email" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "active", "activePortal", "activeApi", "portal", "api", "internal" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMyTeam" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "userName", "salutationName", "firstName", "lastName", "middleName", "name", "type", "authMethod", "apiKey", "secretKey", "isActive", "title", "position", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "token", "authTokenId", "ipAddress", "defaultTeamId", "defaultTeamName", "acceptanceStatus", "acceptanceStatusMeetings", "acceptanceStatusCalls", "teamRole", "teamsIds", "teamsColumns", "teamsNames", "rolesIds", "rolesNames", "portalsIds", "portalsNames", "portalRolesIds", "portalRolesNames", "contactId", "contactName", "accountsIds", "accountsNames", "accountId", "accountName", "portalId", "portalName", "avatarId", "avatarName", "avatarColor", "sendAccessInfo", "gender", "createdAt", "modifiedAt", "createdById", "createdByName", "dashboardTemplateId", "dashboardTemplateName", "workingTimeCalendarId", "workingTimeCalendarName", "layoutSetId", "layoutSetName", "auth2FA", "lastAccess", "emailAddressList", "userEmailAddressList", "excludeFromReplyEmailAddressList", "recordAccessLevels", "targetListIsOptedOut" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'User' records related through the 'assignedUsers' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/User" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Email" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of User record." } } } } } }, "description": "Relate 'User' record though the 'assignedUsers' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Email" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of User record." } } } } } }, "description": "Unrelate 'User' record related though the 'assignedUsers' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Email\/{id}\/replies": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Email" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "subject", "fromName", "fromAddress", "fromString", "replyToString", "replyToName", "replyToAddress", "addressNameMap", "from", "to", "cc", "bcc", "replyTo", "personStringData", "isRead", "isNotRead", "isReplied", "isNotReplied", "isImportant", "inTrash", "inArchive", "folderId", "isUsers", "isUsersSent", "folderName", "folderStringId", "folderStringName", "nameHash", "typeHash", "idHash", "messageId", "messageIdInternal", "emailAddress", "fromEmailAddressId", "fromEmailAddressName", "toEmailAddressesIds", "toEmailAddressesNames", "ccEmailAddressesIds", "ccEmailAddressesNames", "bccEmailAddressesIds", "bccEmailAddressesNames", "replyToEmailAddressesIds", "replyToEmailAddressesNames", "bodyPlain", "body", "isHtml", "status", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "hasAttachment", "parentId", "parentType", "parentName", "dateSent", "deliveryDate", "sendAt", "isAutoReply", "createdAt", "modifiedAt", "createdById", "createdByName", "sentById", "sentByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "repliedId", "repliedName", "repliesIds", "repliesNames", "isSystem", "isJustSent", "isBeingImported", "skipNotificationMap", "teamsIds", "teamsNames", "usersIds", "usersColumns", "usersNames", "assignedUsersIds", "assignedUsersNames", "inboundEmailsIds", "inboundEmailsNames", "emailAccountsIds", "emailAccountsNames", "icsContents", "icsEventData", "icsEventUid", "icsEventDateStart", "icsEventDateStartDate", "createEvent", "createdEventId", "createdEventType", "createdEventName", "groupFolderId", "groupFolderName", "groupStatusFolder", "accountId", "accountName", "tasksIds", "tasksNames" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Email' records related through the 'replies' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Email" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Email" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Email record." } } } } } }, "description": "Relate 'Email' record though the 'replies' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Email" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Email record." } } } } } }, "description": "Unrelate 'Email' record related though the 'replies' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Email\/{id}\/tasks": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Email" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "actual", "completed", "deferred", "todays", "actualStartingNotInFuture", "overdue" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "priority", "dateStart", "dateStartDate", "dateEnd", "dateEndDate", "dateCompleted", "isOverdue", "reminders", "description", "parentId", "parentType", "parentName", "accountId", "accountName", "contactId", "contactName", "originalEmailId", "originalEmailName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Task' records related through the 'tasks' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Task" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Email" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Task record." } } } } } }, "description": "Relate 'Task' record though the 'tasks' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Email" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Task record." } } } } } }, "description": "Unrelate 'Task' record related though the 'tasks' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Email\/{id}\/users": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Email" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "active", "activePortal", "activeApi", "portal", "api", "internal" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMyTeam" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "userName", "salutationName", "firstName", "lastName", "middleName", "name", "type", "authMethod", "apiKey", "secretKey", "isActive", "title", "position", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "token", "authTokenId", "ipAddress", "defaultTeamId", "defaultTeamName", "acceptanceStatus", "acceptanceStatusMeetings", "acceptanceStatusCalls", "teamRole", "teamsIds", "teamsColumns", "teamsNames", "rolesIds", "rolesNames", "portalsIds", "portalsNames", "portalRolesIds", "portalRolesNames", "contactId", "contactName", "accountsIds", "accountsNames", "accountId", "accountName", "portalId", "portalName", "avatarId", "avatarName", "avatarColor", "sendAccessInfo", "gender", "createdAt", "modifiedAt", "createdById", "createdByName", "dashboardTemplateId", "dashboardTemplateName", "workingTimeCalendarId", "workingTimeCalendarName", "layoutSetId", "layoutSetName", "auth2FA", "lastAccess", "emailAddressList", "userEmailAddressList", "excludeFromReplyEmailAddressList", "recordAccessLevels", "targetListIsOptedOut" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'User' records related through the 'users' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/User" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Email" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of User record." } } } } } }, "description": "Relate 'User' record though the 'users' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Email" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of User record." } } } } } }, "description": "Unrelate 'User' record related though the 'users' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/KnowledgeBaseArticle": { "post": { "tags": [ "KnowledgeBaseArticle" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/KnowledgeBaseArticle_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "description": "Create a new KnowledgeBaseArticle record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/KnowledgeBaseArticle" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "KnowledgeBaseArticle" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "published" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "language", "type", "portalsIds", "portalsNames", "publishDate", "expirationDate", "order", "description", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "categoriesIds", "categoriesNames", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "body", "bodyPlain" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List KnowledgeBaseArticle records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/KnowledgeBaseArticle" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/KnowledgeBaseArticle\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "KnowledgeBaseArticle" ], "description": "Read an existing KnowledgeBaseArticle record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/KnowledgeBaseArticle" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "KnowledgeBaseArticle" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/KnowledgeBaseArticle" } } } }, "parameters": [ { "in": "header", "name": "X-Version-Number", "schema": { "type": "string" }, "description": "A version number for optimistic concurrency control. Obtained from the 'versionNumber' field." } ], "description": "Update an existing KnowledgeBaseArticle record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/KnowledgeBaseArticle" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "KnowledgeBaseArticle" ], "description": "Remove an existing KnowledgeBaseArticle record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/KnowledgeBaseArticle\/{id}\/cases": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "KnowledgeBaseArticle" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "open", "closed" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "number", "status", "priority", "type", "description", "accountId", "accountName", "leadId", "leadName", "contactId", "contactName", "contactsIds", "contactsNames", "inboundEmailId", "inboundEmailName", "originalEmailId", "originalEmailName", "isInternal", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Case' records related through the 'cases' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Case" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "KnowledgeBaseArticle" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Case record." } } } } } }, "description": "Relate 'Case' record though the 'cases' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "KnowledgeBaseArticle" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Case record." } } } } } }, "description": "Unrelate 'Case' record related though the 'cases' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Lead": { "post": { "tags": [ "Lead" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Lead_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "description": "Create a new Lead record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Lead" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "Lead" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "actual", "active", "converted" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "salutationName", "firstName", "lastName", "middleName", "name", "title", "status", "source", "industry", "opportunityAmountCurrency", "opportunityAmount", "opportunityAmountConverted", "website", "addressStreet", "addressCity", "addressState", "addressCountry", "addressPostalCode", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "doNotCall", "description", "convertedAt", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "accountName", "assignedUserId", "assignedUserName", "acceptanceStatus", "acceptanceStatusMeetings", "acceptanceStatusCalls", "teamsIds", "teamsNames", "campaignId", "campaignName", "createdAccountId", "createdAccountName", "createdContactId", "createdContactName", "createdOpportunityId", "createdOpportunityName", "targetListsIds", "targetListsNames", "targetListId", "targetListName", "targetListIsOptedOut", "originalEmailId", "originalEmailName", "addressMap", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List Lead records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Lead" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Lead\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Lead" ], "description": "Read an existing Lead record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Lead" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "Lead" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Lead" } } } }, "parameters": [], "description": "Update an existing Lead record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Lead" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "Lead" ], "description": "Remove an existing Lead record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Lead\/{id}\/calls": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Lead" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "planned", "held", "todays" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "dateStart", "dateEnd", "duration", "reminders", "direction", "description", "parentId", "parentType", "parentName", "accountId", "accountName", "uid", "acceptanceStatus", "usersIds", "usersColumns", "usersNames", "contactsIds", "contactsColumns", "contactsNames", "leadsIds", "leadsColumns", "leadsNames", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "phoneNumbersMap", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Call' records related through the 'calls' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Call" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Lead" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Call record." } } } } } }, "description": "Relate 'Call' record though the 'calls' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Lead" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Call record." } } } } } }, "description": "Unrelate 'Call' record related though the 'calls' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Lead\/{id}\/cases": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Lead" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "open", "closed" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "number", "status", "priority", "type", "description", "accountId", "accountName", "leadId", "leadName", "contactId", "contactName", "contactsIds", "contactsNames", "inboundEmailId", "inboundEmailName", "originalEmailId", "originalEmailName", "isInternal", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Case' records related through the 'cases' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Case" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Lead" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Case record." } } } } } }, "description": "Relate 'Case' record though the 'cases' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Lead" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Case record." } } } } } }, "description": "Unrelate 'Case' record related though the 'cases' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Lead\/{id}\/documents": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Lead" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "active", "draft" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "fileId", "fileName", "status", "type", "publishDate", "expirationDate", "description", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "accountsIds", "accountsNames", "folderId", "folderName" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Document' records related through the 'documents' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Document" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Lead" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Document record." } } } } } }, "description": "Relate 'Document' record though the 'documents' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Lead" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Document record." } } } } } }, "description": "Unrelate 'Document' record related though the 'documents' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Lead\/{id}\/emails": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Lead" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "subject", "fromName", "fromAddress", "fromString", "replyToString", "replyToName", "replyToAddress", "addressNameMap", "from", "to", "cc", "bcc", "replyTo", "personStringData", "isRead", "isNotRead", "isReplied", "isNotReplied", "isImportant", "inTrash", "inArchive", "folderId", "isUsers", "isUsersSent", "folderName", "folderStringId", "folderStringName", "nameHash", "typeHash", "idHash", "messageId", "messageIdInternal", "emailAddress", "fromEmailAddressId", "fromEmailAddressName", "toEmailAddressesIds", "toEmailAddressesNames", "ccEmailAddressesIds", "ccEmailAddressesNames", "bccEmailAddressesIds", "bccEmailAddressesNames", "replyToEmailAddressesIds", "replyToEmailAddressesNames", "bodyPlain", "body", "isHtml", "status", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "hasAttachment", "parentId", "parentType", "parentName", "dateSent", "deliveryDate", "sendAt", "isAutoReply", "createdAt", "modifiedAt", "createdById", "createdByName", "sentById", "sentByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "repliedId", "repliedName", "repliesIds", "repliesNames", "isSystem", "isJustSent", "isBeingImported", "skipNotificationMap", "teamsIds", "teamsNames", "usersIds", "usersColumns", "usersNames", "assignedUsersIds", "assignedUsersNames", "inboundEmailsIds", "inboundEmailsNames", "emailAccountsIds", "emailAccountsNames", "icsContents", "icsEventData", "icsEventUid", "icsEventDateStart", "icsEventDateStartDate", "createEvent", "createdEventId", "createdEventType", "createdEventName", "groupFolderId", "groupFolderName", "groupStatusFolder", "accountId", "accountName", "tasksIds", "tasksNames" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Email' records related through the 'emails' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Email" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Lead" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Email record." } } } } } }, "description": "Relate 'Email' record though the 'emails' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Lead" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Email record." } } } } } }, "description": "Unrelate 'Email' record related though the 'emails' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Lead\/{id}\/meetings": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Lead" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "planned", "held", "todays" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "dateStart", "dateStartDate", "dateEnd", "dateEndDate", "isAllDay", "duration", "reminders", "description", "parentId", "parentType", "parentName", "accountId", "accountName", "uid", "joinUrl", "acceptanceStatus", "usersIds", "usersColumns", "usersNames", "contactsIds", "contactsColumns", "contactsNames", "leadsIds", "leadsColumns", "leadsNames", "sourceEmailId", "sourceEmailName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Meeting' records related through the 'meetings' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Meeting" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Lead" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Meeting record." } } } } } }, "description": "Relate 'Meeting' record though the 'meetings' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Lead" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Meeting record." } } } } } }, "description": "Unrelate 'Meeting' record related though the 'meetings' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Lead\/{id}\/targetLists": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Lead" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "categoryId", "categoryName", "entryCount", "optedOutCount", "description", "sourceCampaignId", "sourceCampaignName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "includingActionList", "excludingActionList", "targetStatus", "isOptedOut" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'TargetList' records related through the 'targetLists' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TargetList" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Lead" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of TargetList record." } } } } } }, "description": "Relate 'TargetList' record though the 'targetLists' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Lead" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of TargetList record." } } } } } }, "description": "Unrelate 'TargetList' record related though the 'targetLists' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Lead\/{id}\/tasks": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Lead" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "actual", "completed", "deferred", "todays", "actualStartingNotInFuture", "overdue" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "priority", "dateStart", "dateStartDate", "dateEnd", "dateEndDate", "dateCompleted", "isOverdue", "reminders", "description", "parentId", "parentType", "parentName", "accountId", "accountName", "contactId", "contactName", "originalEmailId", "originalEmailName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Task' records related through the 'tasks' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Task" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Lead" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Task record." } } } } } }, "description": "Relate 'Task' record though the 'tasks' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Lead" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Task record." } } } } } }, "description": "Unrelate 'Task' record related though the 'tasks' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Meeting": { "post": { "tags": [ "Meeting" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Meeting_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "description": "Create a new Meeting record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Meeting" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "Meeting" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "planned", "held", "todays" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "dateStart", "dateStartDate", "dateEnd", "dateEndDate", "isAllDay", "duration", "reminders", "description", "parentId", "parentType", "parentName", "accountId", "accountName", "uid", "joinUrl", "acceptanceStatus", "usersIds", "usersColumns", "usersNames", "contactsIds", "contactsColumns", "contactsNames", "leadsIds", "leadsColumns", "leadsNames", "sourceEmailId", "sourceEmailName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List Meeting records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Meeting" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Meeting\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Meeting" ], "description": "Read an existing Meeting record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Meeting" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "Meeting" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Meeting" } } } }, "parameters": [], "description": "Update an existing Meeting record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Meeting" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "Meeting" ], "description": "Remove an existing Meeting record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Meeting\/{id}\/contacts": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Meeting" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "portalUsers", "notPortalUsers", "accountActive" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "salutationName", "firstName", "lastName", "middleName", "name", "accountAnyId", "title", "description", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "doNotCall", "addressStreet", "addressCity", "addressState", "addressCountry", "addressPostalCode", "accountId", "accountName", "accountsIds", "accountsColumns", "accountsNames", "accountRole", "accountIsInactive", "accountType", "opportunityRole", "acceptanceStatus", "acceptanceStatusMeetings", "acceptanceStatusCalls", "campaignId", "campaignName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "targetListsIds", "targetListsNames", "targetListId", "targetListName", "portalUserId", "portalUserName", "hasPortalUser", "originalLeadId", "originalLeadName", "targetListIsOptedOut", "originalEmailId", "originalEmailName", "addressMap", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Contact' records related through the 'contacts' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Contact" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Meeting" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Contact record." } } } } } }, "description": "Relate 'Contact' record though the 'contacts' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Meeting" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Contact record." } } } } } }, "description": "Unrelate 'Contact' record related though the 'contacts' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Meeting\/{id}\/leads": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Meeting" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "actual", "active", "converted" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "salutationName", "firstName", "lastName", "middleName", "name", "title", "status", "source", "industry", "opportunityAmountCurrency", "opportunityAmount", "opportunityAmountConverted", "website", "addressStreet", "addressCity", "addressState", "addressCountry", "addressPostalCode", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "doNotCall", "description", "convertedAt", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "accountName", "assignedUserId", "assignedUserName", "acceptanceStatus", "acceptanceStatusMeetings", "acceptanceStatusCalls", "teamsIds", "teamsNames", "campaignId", "campaignName", "createdAccountId", "createdAccountName", "createdContactId", "createdContactName", "createdOpportunityId", "createdOpportunityName", "targetListsIds", "targetListsNames", "targetListId", "targetListName", "targetListIsOptedOut", "originalEmailId", "originalEmailName", "addressMap", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Lead' records related through the 'leads' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Lead" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Meeting" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Lead record." } } } } } }, "description": "Relate 'Lead' record though the 'leads' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Meeting" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Lead record." } } } } } }, "description": "Unrelate 'Lead' record related though the 'leads' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Meeting\/{id}\/users": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Meeting" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "active", "activePortal", "activeApi", "portal", "api", "internal" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMyTeam" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "userName", "salutationName", "firstName", "lastName", "middleName", "name", "type", "authMethod", "apiKey", "secretKey", "isActive", "title", "position", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "token", "authTokenId", "ipAddress", "defaultTeamId", "defaultTeamName", "acceptanceStatus", "acceptanceStatusMeetings", "acceptanceStatusCalls", "teamRole", "teamsIds", "teamsColumns", "teamsNames", "rolesIds", "rolesNames", "portalsIds", "portalsNames", "portalRolesIds", "portalRolesNames", "contactId", "contactName", "accountsIds", "accountsNames", "accountId", "accountName", "portalId", "portalName", "avatarId", "avatarName", "avatarColor", "sendAccessInfo", "gender", "createdAt", "modifiedAt", "createdById", "createdByName", "dashboardTemplateId", "dashboardTemplateName", "workingTimeCalendarId", "workingTimeCalendarName", "layoutSetId", "layoutSetName", "auth2FA", "lastAccess", "emailAddressList", "userEmailAddressList", "excludeFromReplyEmailAddressList", "recordAccessLevels", "targetListIsOptedOut" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'User' records related through the 'users' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/User" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Meeting" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of User record." } } } } } }, "description": "Relate 'User' record though the 'users' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Meeting" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of User record." } } } } } }, "description": "Unrelate 'User' record related though the 'users' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Opportunity": { "post": { "tags": [ "Opportunity" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Opportunity_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "description": "Create a new Opportunity record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Opportunity" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "Opportunity" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "open", "won", "lost" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "amountCurrency", "amount", "amountConverted", "amountWeightedConverted", "accountId", "accountName", "contactsIds", "contactsColumns", "contactsNames", "contactId", "contactName", "stage", "lastStage", "probability", "leadSource", "closeDate", "description", "campaignId", "campaignName", "originalLeadId", "originalLeadName", "contactRole", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List Opportunity records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Opportunity" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Opportunity\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Opportunity" ], "description": "Read an existing Opportunity record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Opportunity" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "Opportunity" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Opportunity" } } } }, "parameters": [ { "in": "header", "name": "X-Version-Number", "schema": { "type": "string" }, "description": "A version number for optimistic concurrency control. Obtained from the 'versionNumber' field." } ], "description": "Update an existing Opportunity record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Opportunity" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "Opportunity" ], "description": "Remove an existing Opportunity record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Opportunity\/{id}\/calls": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Opportunity" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "planned", "held", "todays" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "dateStart", "dateEnd", "duration", "reminders", "direction", "description", "parentId", "parentType", "parentName", "accountId", "accountName", "uid", "acceptanceStatus", "usersIds", "usersColumns", "usersNames", "contactsIds", "contactsColumns", "contactsNames", "leadsIds", "leadsColumns", "leadsNames", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "phoneNumbersMap", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Call' records related through the 'calls' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Call" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Opportunity" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Call record." } } } } } }, "description": "Relate 'Call' record though the 'calls' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Opportunity" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Call record." } } } } } }, "description": "Unrelate 'Call' record related though the 'calls' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Opportunity\/{id}\/contacts": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Opportunity" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "portalUsers", "notPortalUsers", "accountActive" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "salutationName", "firstName", "lastName", "middleName", "name", "accountAnyId", "title", "description", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "doNotCall", "addressStreet", "addressCity", "addressState", "addressCountry", "addressPostalCode", "accountId", "accountName", "accountsIds", "accountsColumns", "accountsNames", "accountRole", "accountIsInactive", "accountType", "opportunityRole", "acceptanceStatus", "acceptanceStatusMeetings", "acceptanceStatusCalls", "campaignId", "campaignName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "targetListsIds", "targetListsNames", "targetListId", "targetListName", "portalUserId", "portalUserName", "hasPortalUser", "originalLeadId", "originalLeadName", "targetListIsOptedOut", "originalEmailId", "originalEmailName", "addressMap", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Contact' records related through the 'contacts' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Contact" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Opportunity" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Contact record." } } } } } }, "description": "Relate 'Contact' record though the 'contacts' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Opportunity" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Contact record." } } } } } }, "description": "Unrelate 'Contact' record related though the 'contacts' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Opportunity\/{id}\/documents": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Opportunity" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "active", "draft" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "fileId", "fileName", "status", "type", "publishDate", "expirationDate", "description", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "accountsIds", "accountsNames", "folderId", "folderName" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Document' records related through the 'documents' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Document" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Opportunity" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Document record." } } } } } }, "description": "Relate 'Document' record though the 'documents' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Opportunity" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Document record." } } } } } }, "description": "Unrelate 'Document' record related though the 'documents' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Opportunity\/{id}\/emails": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Opportunity" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "subject", "fromName", "fromAddress", "fromString", "replyToString", "replyToName", "replyToAddress", "addressNameMap", "from", "to", "cc", "bcc", "replyTo", "personStringData", "isRead", "isNotRead", "isReplied", "isNotReplied", "isImportant", "inTrash", "inArchive", "folderId", "isUsers", "isUsersSent", "folderName", "folderStringId", "folderStringName", "nameHash", "typeHash", "idHash", "messageId", "messageIdInternal", "emailAddress", "fromEmailAddressId", "fromEmailAddressName", "toEmailAddressesIds", "toEmailAddressesNames", "ccEmailAddressesIds", "ccEmailAddressesNames", "bccEmailAddressesIds", "bccEmailAddressesNames", "replyToEmailAddressesIds", "replyToEmailAddressesNames", "bodyPlain", "body", "isHtml", "status", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "hasAttachment", "parentId", "parentType", "parentName", "dateSent", "deliveryDate", "sendAt", "isAutoReply", "createdAt", "modifiedAt", "createdById", "createdByName", "sentById", "sentByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "repliedId", "repliedName", "repliesIds", "repliesNames", "isSystem", "isJustSent", "isBeingImported", "skipNotificationMap", "teamsIds", "teamsNames", "usersIds", "usersColumns", "usersNames", "assignedUsersIds", "assignedUsersNames", "inboundEmailsIds", "inboundEmailsNames", "emailAccountsIds", "emailAccountsNames", "icsContents", "icsEventData", "icsEventUid", "icsEventDateStart", "icsEventDateStartDate", "createEvent", "createdEventId", "createdEventType", "createdEventName", "groupFolderId", "groupFolderName", "groupStatusFolder", "accountId", "accountName", "tasksIds", "tasksNames" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Email' records related through the 'emails' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Email" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Opportunity" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Email record." } } } } } }, "description": "Relate 'Email' record though the 'emails' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Opportunity" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Email record." } } } } } }, "description": "Unrelate 'Email' record related though the 'emails' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Opportunity\/{id}\/meetings": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Opportunity" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "planned", "held", "todays" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "dateStart", "dateStartDate", "dateEnd", "dateEndDate", "isAllDay", "duration", "reminders", "description", "parentId", "parentType", "parentName", "accountId", "accountName", "uid", "joinUrl", "acceptanceStatus", "usersIds", "usersColumns", "usersNames", "contactsIds", "contactsColumns", "contactsNames", "leadsIds", "leadsColumns", "leadsNames", "sourceEmailId", "sourceEmailName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Meeting' records related through the 'meetings' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Meeting" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Opportunity" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Meeting record." } } } } } }, "description": "Relate 'Meeting' record though the 'meetings' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Opportunity" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Meeting record." } } } } } }, "description": "Unrelate 'Meeting' record related though the 'meetings' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Opportunity\/{id}\/tasks": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Opportunity" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "actual", "completed", "deferred", "todays", "actualStartingNotInFuture", "overdue" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "priority", "dateStart", "dateStartDate", "dateEnd", "dateEndDate", "dateCompleted", "isOverdue", "reminders", "description", "parentId", "parentType", "parentName", "accountId", "accountName", "contactId", "contactName", "originalEmailId", "originalEmailName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Task' records related through the 'tasks' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Task" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "Opportunity" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Task record." } } } } } }, "description": "Relate 'Task' record though the 'tasks' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "Opportunity" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Task record." } } } } } }, "description": "Unrelate 'Task' record related though the 'tasks' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/TargetList": { "post": { "tags": [ "TargetList" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TargetList_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "description": "Create a new TargetList record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TargetList" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "TargetList" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "categoryId", "categoryName", "entryCount", "optedOutCount", "description", "sourceCampaignId", "sourceCampaignName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "includingActionList", "excludingActionList", "targetStatus", "isOptedOut" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List TargetList records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TargetList" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/TargetList\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "TargetList" ], "description": "Read an existing TargetList record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TargetList" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "TargetList" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TargetList" } } } }, "parameters": [], "description": "Update an existing TargetList record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TargetList" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "TargetList" ], "description": "Remove an existing TargetList record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/TargetList\/{id}\/accounts": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "TargetList" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "customers", "resellers", "partners", "recentlyCreated" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "website", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "type", "industry", "sicCode", "contactRole", "contactIsInactive", "billingAddressStreet", "billingAddressCity", "billingAddressState", "billingAddressCountry", "billingAddressPostalCode", "shippingAddressStreet", "shippingAddressCity", "shippingAddressState", "shippingAddressCountry", "shippingAddressPostalCode", "description", "campaignId", "campaignName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "targetListsIds", "targetListsNames", "targetListId", "targetListName", "originalLeadId", "originalLeadName", "targetListIsOptedOut", "billingAddressMap", "shippingAddressMap", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Account' records related through the 'accounts' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Account" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "TargetList" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Account record." } } } } } }, "description": "Relate 'Account' record though the 'accounts' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "TargetList" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Account record." } } } } } }, "description": "Unrelate 'Account' record related though the 'accounts' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/TargetList\/{id}\/campaigns": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "TargetList" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "active" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "type", "startDate", "endDate", "description", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "targetListsIds", "targetListsNames", "excludingTargetListsIds", "excludingTargetListsNames", "sentCount", "openedCount", "clickedCount", "optedInCount", "optedOutCount", "bouncedCount", "hardBouncedCount", "softBouncedCount", "leadCreatedCount", "openedPercentage", "clickedPercentage", "optedOutPercentage", "bouncedPercentage", "revenueCurrency", "revenue", "budgetCurrency", "budget", "contactsTemplateId", "contactsTemplateName", "leadsTemplateId", "leadsTemplateName", "accountsTemplateId", "accountsTemplateName", "usersTemplateId", "usersTemplateName", "mailMergeOnlyWithAddress", "revenueConverted", "budgetConverted" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Campaign' records related through the 'campaigns' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Campaign" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "TargetList" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Campaign record." } } } } } }, "description": "Relate 'Campaign' record though the 'campaigns' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "TargetList" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Campaign record." } } } } } }, "description": "Unrelate 'Campaign' record related though the 'campaigns' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/TargetList\/{id}\/campaignsExcluding": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "TargetList" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "active" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "type", "startDate", "endDate", "description", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "targetListsIds", "targetListsNames", "excludingTargetListsIds", "excludingTargetListsNames", "sentCount", "openedCount", "clickedCount", "optedInCount", "optedOutCount", "bouncedCount", "hardBouncedCount", "softBouncedCount", "leadCreatedCount", "openedPercentage", "clickedPercentage", "optedOutPercentage", "bouncedPercentage", "revenueCurrency", "revenue", "budgetCurrency", "budget", "contactsTemplateId", "contactsTemplateName", "leadsTemplateId", "leadsTemplateName", "accountsTemplateId", "accountsTemplateName", "usersTemplateId", "usersTemplateName", "mailMergeOnlyWithAddress", "revenueConverted", "budgetConverted" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Campaign' records related through the 'campaignsExcluding' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Campaign" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "TargetList" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Campaign record." } } } } } }, "description": "Relate 'Campaign' record though the 'campaignsExcluding' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "TargetList" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Campaign record." } } } } } }, "description": "Unrelate 'Campaign' record related though the 'campaignsExcluding' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/TargetList\/{id}\/contacts": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "TargetList" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "portalUsers", "notPortalUsers", "accountActive" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "salutationName", "firstName", "lastName", "middleName", "name", "accountAnyId", "title", "description", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "doNotCall", "addressStreet", "addressCity", "addressState", "addressCountry", "addressPostalCode", "accountId", "accountName", "accountsIds", "accountsColumns", "accountsNames", "accountRole", "accountIsInactive", "accountType", "opportunityRole", "acceptanceStatus", "acceptanceStatusMeetings", "acceptanceStatusCalls", "campaignId", "campaignName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "targetListsIds", "targetListsNames", "targetListId", "targetListName", "portalUserId", "portalUserName", "hasPortalUser", "originalLeadId", "originalLeadName", "targetListIsOptedOut", "originalEmailId", "originalEmailName", "addressMap", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Contact' records related through the 'contacts' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Contact" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "TargetList" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Contact record." } } } } } }, "description": "Relate 'Contact' record though the 'contacts' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "TargetList" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Contact record." } } } } } }, "description": "Unrelate 'Contact' record related though the 'contacts' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/TargetList\/{id}\/leads": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "TargetList" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "actual", "active", "converted" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "salutationName", "firstName", "lastName", "middleName", "name", "title", "status", "source", "industry", "opportunityAmountCurrency", "opportunityAmount", "opportunityAmountConverted", "website", "addressStreet", "addressCity", "addressState", "addressCountry", "addressPostalCode", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "doNotCall", "description", "convertedAt", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "accountName", "assignedUserId", "assignedUserName", "acceptanceStatus", "acceptanceStatusMeetings", "acceptanceStatusCalls", "teamsIds", "teamsNames", "campaignId", "campaignName", "createdAccountId", "createdAccountName", "createdContactId", "createdContactName", "createdOpportunityId", "createdOpportunityName", "targetListsIds", "targetListsNames", "targetListId", "targetListName", "targetListIsOptedOut", "originalEmailId", "originalEmailName", "addressMap", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Lead' records related through the 'leads' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Lead" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "TargetList" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Lead record." } } } } } }, "description": "Relate 'Lead' record though the 'leads' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "TargetList" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Lead record." } } } } } }, "description": "Unrelate 'Lead' record related though the 'leads' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/TargetList\/{id}\/users": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "TargetList" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "active", "activePortal", "activeApi", "portal", "api", "internal" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMyTeam" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "userName", "salutationName", "firstName", "lastName", "middleName", "name", "type", "authMethod", "apiKey", "secretKey", "isActive", "title", "position", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "token", "authTokenId", "ipAddress", "defaultTeamId", "defaultTeamName", "acceptanceStatus", "acceptanceStatusMeetings", "acceptanceStatusCalls", "teamRole", "teamsIds", "teamsColumns", "teamsNames", "rolesIds", "rolesNames", "portalsIds", "portalsNames", "portalRolesIds", "portalRolesNames", "contactId", "contactName", "accountsIds", "accountsNames", "accountId", "accountName", "portalId", "portalName", "avatarId", "avatarName", "avatarColor", "sendAccessInfo", "gender", "createdAt", "modifiedAt", "createdById", "createdByName", "dashboardTemplateId", "dashboardTemplateName", "workingTimeCalendarId", "workingTimeCalendarName", "layoutSetId", "layoutSetName", "auth2FA", "lastAccess", "emailAddressList", "userEmailAddressList", "excludeFromReplyEmailAddressList", "recordAccessLevels", "targetListIsOptedOut" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'User' records related through the 'users' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/User" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "TargetList" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of User record." } } } } } }, "description": "Relate 'User' record though the 'users' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "TargetList" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of User record." } } } } } }, "description": "Unrelate 'User' record related though the 'users' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Task": { "post": { "tags": [ "Task" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Task_create" } } } }, "parameters": [ { "in": "header", "name": "X-Skip-Duplicate-Check", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Skip duplicate check." }, { "in": "header", "name": "X-Duplicate-Source-Id", "schema": { "type": "string" }, "description": "A record ID of the entity that is being duplicated." } ], "description": "Create a new Task record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Task" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check." } } }, "get": { "tags": [ "Task" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "actual", "completed", "deferred", "todays", "actualStartingNotInFuture", "overdue" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "priority", "dateStart", "dateStartDate", "dateEnd", "dateEndDate", "dateCompleted", "isOverdue", "reminders", "description", "parentId", "parentType", "parentName", "accountId", "accountName", "contactId", "contactName", "originalEmailId", "originalEmailName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List Task records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Task" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/Task\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "Task" ], "description": "Read an existing Task record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Task" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "Task" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Task" } } } }, "parameters": [ { "in": "header", "name": "X-Version-Number", "schema": { "type": "string" }, "description": "A version number for optimistic concurrency control. Obtained from the 'versionNumber' field." } ], "description": "Update an existing Task record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Task" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } }, "delete": { "tags": [ "Task" ], "description": "Remove an existing Task record.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "boolean", "description": "Always true. Do not check the value." } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/User": { "get": { "tags": [ "User" ], "parameters": [ { "in": "header", "name": "X-No-Total", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Disable calculation of the total number of records." }, { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "active", "activePortal", "activeApi", "portal", "api", "internal" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMyTeam" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "userName", "salutationName", "firstName", "lastName", "middleName", "name", "type", "authMethod", "apiKey", "secretKey", "isActive", "title", "position", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "token", "authTokenId", "ipAddress", "defaultTeamId", "defaultTeamName", "acceptanceStatus", "acceptanceStatusMeetings", "acceptanceStatusCalls", "teamRole", "teamsIds", "teamsColumns", "teamsNames", "rolesIds", "rolesNames", "portalsIds", "portalsNames", "portalRolesIds", "portalRolesNames", "contactId", "contactName", "accountsIds", "accountsNames", "accountId", "accountName", "portalId", "portalName", "avatarId", "avatarName", "avatarColor", "sendAccessInfo", "gender", "createdAt", "modifiedAt", "createdById", "createdByName", "dashboardTemplateId", "dashboardTemplateName", "workingTimeCalendarId", "workingTimeCalendarName", "layoutSetId", "layoutSetName", "auth2FA", "lastAccess", "emailAddressList", "userEmailAddressList", "excludeFromReplyEmailAddressList", "recordAccessLevels", "targetListIsOptedOut" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List User records.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/User" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/User\/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "User" ], "description": "Read an existing User record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/User" } } }, "description": "Success." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "patch": { "tags": [ "User" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/User" } } } }, "parameters": [], "description": "Update an existing User record.", "responses": { "200": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/User" } } }, "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." }, "409": { "description": "Conflict." } } } }, "\/User\/{id}\/accounts": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "User" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "customers", "resellers", "partners", "recentlyCreated" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "website", "emailAddressIsOptedOut", "emailAddressIsInvalid", "emailAddress", "emailAddressData", "phoneNumberIsOptedOut", "phoneNumberIsInvalid", "phoneNumber", "phoneNumberData", "type", "industry", "sicCode", "contactRole", "contactIsInactive", "billingAddressStreet", "billingAddressCity", "billingAddressState", "billingAddressCountry", "billingAddressPostalCode", "shippingAddressStreet", "shippingAddressCity", "shippingAddressState", "shippingAddressCountry", "shippingAddressPostalCode", "description", "campaignId", "campaignName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "targetListsIds", "targetListsNames", "targetListId", "targetListName", "originalLeadId", "originalLeadName", "targetListIsOptedOut", "billingAddressMap", "shippingAddressMap", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Account' records related through the 'accounts' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Account" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "User" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Account record." } } } } } }, "description": "Relate 'Account' record though the 'accounts' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "User" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Account record." } } } } } }, "description": "Unrelate 'Account' record related though the 'accounts' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/User\/{id}\/calls": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "User" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "planned", "held", "todays" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "dateStart", "dateEnd", "duration", "reminders", "direction", "description", "parentId", "parentType", "parentName", "accountId", "accountName", "uid", "acceptanceStatus", "usersIds", "usersColumns", "usersNames", "contactsIds", "contactsColumns", "contactsNames", "leadsIds", "leadsColumns", "leadsNames", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "phoneNumbersMap", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Call' records related through the 'calls' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Call" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "User" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Call record." } } } } } }, "description": "Relate 'Call' record though the 'calls' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "User" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Call record." } } } } } }, "description": "Unrelate 'Call' record related though the 'calls' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/User\/{id}\/emails": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "User" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "subject", "fromName", "fromAddress", "fromString", "replyToString", "replyToName", "replyToAddress", "addressNameMap", "from", "to", "cc", "bcc", "replyTo", "personStringData", "isRead", "isNotRead", "isReplied", "isNotReplied", "isImportant", "inTrash", "inArchive", "folderId", "isUsers", "isUsersSent", "folderName", "folderStringId", "folderStringName", "nameHash", "typeHash", "idHash", "messageId", "messageIdInternal", "emailAddress", "fromEmailAddressId", "fromEmailAddressName", "toEmailAddressesIds", "toEmailAddressesNames", "ccEmailAddressesIds", "ccEmailAddressesNames", "bccEmailAddressesIds", "bccEmailAddressesNames", "replyToEmailAddressesIds", "replyToEmailAddressesNames", "bodyPlain", "body", "isHtml", "status", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "hasAttachment", "parentId", "parentType", "parentName", "dateSent", "deliveryDate", "sendAt", "isAutoReply", "createdAt", "modifiedAt", "createdById", "createdByName", "sentById", "sentByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "repliedId", "repliedName", "repliesIds", "repliesNames", "isSystem", "isJustSent", "isBeingImported", "skipNotificationMap", "teamsIds", "teamsNames", "usersIds", "usersColumns", "usersNames", "assignedUsersIds", "assignedUsersNames", "inboundEmailsIds", "inboundEmailsNames", "emailAccountsIds", "emailAccountsNames", "icsContents", "icsEventData", "icsEventUid", "icsEventDateStart", "icsEventDateStartDate", "createEvent", "createdEventId", "createdEventType", "createdEventName", "groupFolderId", "groupFolderName", "groupStatusFolder", "accountId", "accountName", "tasksIds", "tasksNames" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Email' records related through the 'emails' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Email" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "User" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Email record." } } } } } }, "description": "Relate 'Email' record though the 'emails' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "User" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Email record." } } } } } }, "description": "Unrelate 'Email' record related though the 'emails' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/User\/{id}\/meetings": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "User" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "planned", "held", "todays" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "dateStart", "dateStartDate", "dateEnd", "dateEndDate", "isAllDay", "duration", "reminders", "description", "parentId", "parentType", "parentName", "accountId", "accountName", "uid", "joinUrl", "acceptanceStatus", "usersIds", "usersColumns", "usersNames", "contactsIds", "contactsColumns", "contactsNames", "leadsIds", "leadsColumns", "leadsNames", "sourceEmailId", "sourceEmailName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Meeting' records related through the 'meetings' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Meeting" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "User" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Meeting record." } } } } } }, "description": "Relate 'Meeting' record though the 'meetings' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "User" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Meeting record." } } } } } }, "description": "Unrelate 'Meeting' record related though the 'meetings' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/User\/{id}\/targetLists": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "User" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "categoryId", "categoryName", "entryCount", "optedOutCount", "description", "sourceCampaignId", "sourceCampaignName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "includingActionList", "excludingActionList", "targetStatus", "isOptedOut" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'TargetList' records related through the 'targetLists' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TargetList" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "User" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of TargetList record." } } } } } }, "description": "Relate 'TargetList' record though the 'targetLists' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "User" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of TargetList record." } } } } } }, "description": "Unrelate 'TargetList' record related though the 'targetLists' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } }, "\/User\/{id}\/tasks": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A record ID." } ], "get": { "tags": [ "User" ], "parameters": [ { "in": "query", "name": "searchParams", "content": { "application\/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "description": "A pagination offset." }, "maxSize": { "type": "integer", "minimum": 0, "maximum": 200, "description": "The maximum number of records to return." }, "orderBy": { "type": "string", "description": "An attribute (field) to order by." }, "order": { "type": "string", "enum": [ "asc", "desc" ], "description": "An order direction." }, "textFilter": { "type": "string", "description": "A text filter query. Wildcard (*) is supported." }, "primaryFilter": { "type": "string", "enum": [ "actual", "completed", "deferred", "todays", "actualStartingNotInFuture", "overdue" ], "description": "A primary filter." }, "boolFilterList": { "type": "array", "items": { "type": "string", "enum": [ "onlyMy" ] }, "description": "Bool filters." }, "select": { "type": "array", "items": { "type": "string", "enum": [ "name", "status", "priority", "dateStart", "dateStartDate", "dateEnd", "dateEndDate", "dateCompleted", "isOverdue", "reminders", "description", "parentId", "parentType", "parentName", "accountId", "accountName", "contactId", "contactName", "originalEmailId", "originalEmailName", "createdAt", "modifiedAt", "createdById", "createdByName", "modifiedById", "modifiedByName", "assignedUserId", "assignedUserName", "teamsIds", "teamsNames", "attachmentsIds", "attachmentsNames", "attachmentsTypes", "streamUpdatedAt" ] }, "description": "Attributes to return. Select only the necessary ones to improve performance." }, "where": { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" }, "description": "Where items." } } } } }, "description": "Disable calculation of the total number of records." } ], "description": "List 'Task' records related through the 'tasks' link.", "responses": { "200": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Task" }, "description": "Records." }, "total": { "type": "number", "description": "The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records." } } } } }, "description": "Success." }, "400": { "description": "Bad request. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "post": { "tags": [ "User" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Task record." } } } } } }, "description": "Relate 'Task' record though the 'tasks' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } }, "delete": { "tags": [ "User" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID of Task record." } } } } } }, "description": "Unrelate 'Task' record related though the 'tasks' link.", "responses": { "200": { "description": "Success." }, "400": { "description": "Bad request. Might be a validation error. Check logs for details." }, "403": { "description": "Forbidden. Might be an access control error. Check logs for details." } } } } }, "components": { "schemas": { "Account": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 249, "readOnly": false, "description": "A one-line string." }, "website": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "emailAddress": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A primary email address." }, "emailAddressData": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "emailAddress": { "type": "string" }, "primary": { "type": "boolean" }, "optOut": { "type": "boolean" }, "invalid": { "type": "boolean" }, "lower": { "type": "string", "readOnly": true } }, "required": [ "emailAddress", "primary" ] }, "description": "Multiple email addresses" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 36, "readOnly": false, "description": "A primary phone number." }, "phoneNumberData": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "phoneNumber": { "type": "string" }, "primary": { "type": "boolean" }, "optOut": { "type": "boolean" }, "invalid": { "type": "boolean" }, "type": { "type": "string", "enum": [ "Office", "Mobile", "Fax", "Other" ] } }, "required": [ "phoneNumber", "primary" ] }, "description": "Multiple phone numbers." }, "type": { "type": [ "string", "null" ], "readOnly": false, "enum": [ "Customer", "Investor", "Partner", "Reseller" ] }, "industry": { "type": [ "string", "null" ], "readOnly": false, "enum": [ "Advertising", "Aerospace", "Agriculture", "Apparel & Accessories", "Architecture", "Automotive", "Banking", "Biotechnology", "Building Materials & Equipment", "Chemical", "Construction", "Consulting", "Computer", "Culture", "Creative", "Defense", "Education", "Electronics", "Electric Power", "Energy", "Entertainment & Leisure", "Finance", "Food & Beverage", "Grocery", "Healthcare", "Hospitality", "Insurance", "Legal", "Manufacturing", "Mass Media", "Marketing", "Mining", "Music", "Publishing", "Petroleum", "Real Estate", "Retail", "Service", "Sports", "Software", "Support", "Shipping", "Travel", "Technology", "Telecommunications", "Television", "Transportation", "Testing, Inspection & Certification", "Venture Capital", "Wholesale", "Water" ] }, "sicCode": { "type": [ "string", "null" ], "maxLength": 40, "readOnly": false, "description": "A one-line string." }, "billingAddressStreet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A multi-line text." }, "billingAddressCity": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "billingAddressState": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "billingAddressCountry": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "billingAddressPostalCode": { "type": [ "string", "null" ], "maxLength": 40, "readOnly": false, "description": "A one-line string." }, "shippingAddressStreet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A multi-line text." }, "shippingAddressCity": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "shippingAddressState": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "shippingAddressCountry": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "shippingAddressPostalCode": { "type": [ "string", "null" ], "maxLength": 40, "readOnly": false, "description": "A one-line string." }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "campaignId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Campaign type." }, "campaignName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "assignedUserId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "targetListsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the TargetList type." }, "targetListsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "targetListId": { "type": [ "string", "null" ], "readOnly": false }, "targetListName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "originalLeadId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Lead type." }, "originalLeadName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "emailAddressIsOptedOut": { "type": "boolean", "readOnly": false }, "emailAddressIsInvalid": { "type": "boolean", "readOnly": false }, "phoneNumberIsOptedOut": { "type": "boolean", "readOnly": false }, "phoneNumberIsInvalid": { "type": "boolean", "readOnly": false }, "streamUpdatedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." } } }, "Account_create": { "$ref": "#\/components\/schemas\/Account", "type": "object", "required": [ "name" ] }, "Call": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "status": { "type": "string", "readOnly": false, "enum": [ "Planned", "Held", "Not Held" ] }, "dateStart": { "type": "string", "readOnly": false, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "dateEnd": { "type": "string", "readOnly": false, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "direction": { "type": "string", "readOnly": false, "enum": [ "Outbound", "Inbound" ] }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "parentId": { "type": [ "string", "null" ], "readOnly": false, "description": "A foreign record ID." }, "parentType": { "type": [ "string", "null" ], "readOnly": false, "enum": [ "Account", "Lead", "Contact", "Opportunity", "Case" ], "description": "An entity type." }, "parentName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "accountId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "uid": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "acceptanceStatus": { "type": "string", "readOnly": false, "enum": [ "None", "Accepted", "Tentative", "Declined" ] }, "usersIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the User type." }, "usersNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "usersColumns": { "type": [ "object", "null" ], "readOnly": false, "description": "An {ID => object} map. Relationship column values.", "additionalProperties": { "type": "object", "properties": { "status": { "type": "string" } } } }, "contactsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Contact type." }, "contactsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "contactsColumns": { "type": [ "object", "null" ], "readOnly": false, "description": "An {ID => object} map. Relationship column values.", "additionalProperties": { "type": "object", "properties": { "status": { "type": "string" } } } }, "leadsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Lead type." }, "leadsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "leadsColumns": { "type": [ "object", "null" ], "readOnly": false, "description": "An {ID => object} map. Relationship column values.", "additionalProperties": { "type": "object", "properties": { "status": { "type": "string" } } } }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "assignedUserId": { "type": "string", "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." } } }, "Call_create": { "$ref": "#\/components\/schemas\/Call", "type": "object", "required": [ "name", "dateStart", "dateEnd", "assignedUserId" ] }, "Campaign": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "status": { "type": "string", "readOnly": false, "enum": [ "Planning", "Active", "Inactive", "Complete" ] }, "type": { "type": "string", "readOnly": false, "enum": [ "Email", "Newsletter", "Informational Email", "Web", "Television", "Radio", "Mail" ] }, "startDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "endDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "assignedUserId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "targetListsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the TargetList type." }, "targetListsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "excludingTargetListsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the TargetList type." }, "excludingTargetListsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "sentCount": { "type": [ "integer", "null" ], "readOnly": true }, "openedCount": { "type": [ "integer", "null" ], "readOnly": true }, "clickedCount": { "type": [ "integer", "null" ], "readOnly": true }, "optedInCount": { "type": [ "integer", "null" ], "readOnly": true }, "optedOutCount": { "type": [ "integer", "null" ], "readOnly": true }, "bouncedCount": { "type": [ "integer", "null" ], "readOnly": true }, "hardBouncedCount": { "type": [ "integer", "null" ], "readOnly": true }, "softBouncedCount": { "type": [ "integer", "null" ], "readOnly": true }, "leadCreatedCount": { "type": [ "integer", "null" ], "readOnly": true }, "revenue": { "readOnly": true, "type": [ "number", "null" ], "description": "A currency amount." }, "revenueCurrency": { "type": [ "string", "null" ], "enum": [ "USD" ], "readOnly": true, "description": "A code." }, "budget": { "readOnly": false, "type": [ "number", "null" ], "description": "A currency amount." }, "budgetCurrency": { "type": [ "string", "null" ], "enum": [ "USD" ], "readOnly": false, "description": "A code." }, "contactsTemplateId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Template type." }, "contactsTemplateName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "leadsTemplateId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Template type." }, "leadsTemplateName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "accountsTemplateId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Template type." }, "accountsTemplateName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "usersTemplateId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Template type." }, "usersTemplateName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "mailMergeOnlyWithAddress": { "type": "boolean", "readOnly": false }, "revenueConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "budgetConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." } } }, "Campaign_create": { "$ref": "#\/components\/schemas\/Campaign", "type": "object", "required": [ "name" ] }, "Case": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "number": { "type": "integer", "readOnly": true, "description": "An auto-increment number." }, "status": { "type": "string", "readOnly": false, "enum": [ "New", "Assigned", "Pending", "Closed", "Rejected", "Duplicate" ] }, "priority": { "type": "string", "readOnly": false, "enum": [ "Low", "Normal", "High", "Urgent" ] }, "type": { "type": [ "string", "null" ], "readOnly": false, "enum": [ "Question", "Incident", "Problem" ] }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "accountId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "leadId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Lead type." }, "leadName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "contactId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Contact type." }, "contactName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "contactsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Contact type." }, "contactsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "inboundEmailId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the InboundEmail type." }, "inboundEmailName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "originalEmailId": { "type": [ "string", "null" ], "readOnly": false }, "originalEmailName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "isInternal": { "type": "boolean", "readOnly": false }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "assignedUserId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "streamUpdatedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." } } }, "Case_create": { "$ref": "#\/components\/schemas\/Case", "type": "object", "required": [ "name" ] }, "Contact": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "salutationName": { "type": [ "string", "null" ], "readOnly": false, "enum": [ "Mr.", "Ms.", "Mrs.", "Dr." ] }, "firstName": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "lastName": { "type": "string", "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "title": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "emailAddress": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A primary email address." }, "emailAddressData": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "emailAddress": { "type": "string" }, "primary": { "type": "boolean" }, "optOut": { "type": "boolean" }, "invalid": { "type": "boolean" }, "lower": { "type": "string", "readOnly": true } }, "required": [ "emailAddress", "primary" ] }, "description": "Multiple email addresses" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 36, "readOnly": false, "description": "A primary phone number." }, "phoneNumberData": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "phoneNumber": { "type": "string" }, "primary": { "type": "boolean" }, "optOut": { "type": "boolean" }, "invalid": { "type": "boolean" }, "type": { "type": "string", "enum": [ "Mobile", "Office", "Home", "Fax", "Other" ] } }, "required": [ "phoneNumber", "primary" ] }, "description": "Multiple phone numbers." }, "doNotCall": { "type": "boolean", "readOnly": false }, "addressStreet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A multi-line text." }, "addressCity": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "addressState": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "addressCountry": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "addressPostalCode": { "type": [ "string", "null" ], "maxLength": 40, "readOnly": false, "description": "A one-line string." }, "accountId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "accountsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Account type." }, "accountsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "accountsColumns": { "type": [ "object", "null" ], "readOnly": false, "description": "An {ID => object} map. Relationship column values.", "additionalProperties": { "type": "object", "properties": { "role": { "type": "string", "maxLength": 100 }, "isInactive": { "type": "boolean" } } } }, "accountRole": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "accountIsInactive": { "type": "boolean", "readOnly": false }, "accountType": { "readOnly": true, "type": [ "string", "null" ] }, "opportunityRole": { "type": [ "string", "null" ], "readOnly": false, "enum": [ "Decision Maker", "Evaluator", "Influencer" ] }, "acceptanceStatusMeetings": { "type": "string", "readOnly": false }, "acceptanceStatusCalls": { "type": "string", "readOnly": false }, "campaignId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Campaign type." }, "campaignName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "assignedUserId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "targetListsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the TargetList type." }, "targetListsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "targetListId": { "type": [ "string", "null" ], "readOnly": false }, "targetListName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "portalUserId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "portalUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "hasPortalUser": { "type": "boolean", "readOnly": true }, "originalLeadId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Lead type." }, "originalLeadName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "originalEmailId": { "type": [ "string", "null" ], "readOnly": false }, "originalEmailName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "middleName": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "emailAddressIsOptedOut": { "type": "boolean", "readOnly": false }, "emailAddressIsInvalid": { "type": "boolean", "readOnly": false }, "phoneNumberIsOptedOut": { "type": "boolean", "readOnly": false }, "phoneNumberIsInvalid": { "type": "boolean", "readOnly": false }, "streamUpdatedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." } } }, "Contact_create": { "$ref": "#\/components\/schemas\/Contact", "type": "object", "required": [ "lastName" ] }, "Document": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "fileId": { "type": "string", "readOnly": false, "description": "An ID of the record of the Attachment type." }, "fileName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "status": { "type": "string", "readOnly": false, "enum": [ "Draft", "Active", "Canceled", "Expired" ] }, "type": { "type": [ "string", "null" ], "readOnly": false, "enum": [ "Contract", "NDA", "EULA", "License Agreement" ] }, "publishDate": { "type": "string", "readOnly": false, "format": "date", "description": "A date." }, "expirationDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "assignedUserId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "accountsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Account type." }, "accountsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "folderId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the DocumentFolder type." }, "folderName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." } } }, "Document_create": { "$ref": "#\/components\/schemas\/Document", "type": "object", "required": [ "name", "fileId", "publishDate" ] }, "Email": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "subject": { "type": "string", "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "fromName": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "fromAddress": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "fromString": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "replyToString": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "replyToName": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "replyToAddress": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "from": { "type": "string", "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "to": { "type": "string", "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "cc": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "bcc": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "replyTo": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "personStringData": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "isRead": { "type": "boolean", "readOnly": true }, "isNotRead": { "type": "boolean", "readOnly": true }, "isReplied": { "type": "boolean", "readOnly": true }, "isNotReplied": { "type": "boolean", "readOnly": true }, "isImportant": { "type": "boolean", "readOnly": true }, "inTrash": { "type": "boolean", "readOnly": true }, "inArchive": { "type": "boolean", "readOnly": true }, "folderId": { "type": [ "string", "null" ], "readOnly": true }, "isUsers": { "type": "boolean", "readOnly": true }, "folderName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "folderStringId": { "type": [ "string", "null" ], "readOnly": true }, "folderStringName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "messageId": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "messageIdInternal": { "type": [ "string", "null" ], "maxLength": 300, "readOnly": true, "description": "A one-line string." }, "emailAddress": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "fromEmailAddressId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the EmailAddress type." }, "fromEmailAddressName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "toEmailAddressesIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": true, "description": "IDs of records of the EmailAddress type." }, "toEmailAddressesNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "ccEmailAddressesIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": true, "description": "IDs of records of the EmailAddress type." }, "ccEmailAddressesNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "bccEmailAddressesIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": true, "description": "IDs of records of the EmailAddress type." }, "bccEmailAddressesNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "replyToEmailAddressesIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": true, "description": "IDs of records of the EmailAddress type." }, "replyToEmailAddressesNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "bodyPlain": { "type": [ "string", "null" ], "readOnly": true, "description": "A multi-line text." }, "body": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "isHtml": { "type": "boolean", "readOnly": false }, "status": { "type": "string", "readOnly": false, "enum": [ "Draft", "Sending", "Sent", "Archived", "Failed" ] }, "hasAttachment": { "type": "boolean", "readOnly": true }, "parentId": { "type": [ "string", "null" ], "readOnly": false, "description": "A foreign record ID." }, "parentType": { "type": [ "string", "null" ], "readOnly": false, "enum": [ "Account", "Lead", "Contact", "Opportunity", "Case" ], "description": "An entity type." }, "parentName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "dateSent": { "type": [ "string", "null" ], "readOnly": false, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "deliveryDate": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "sendAt": { "type": [ "string", "null" ], "readOnly": false, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "isAutoReply": { "type": "boolean", "readOnly": true }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "sentById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "sentByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "assignedUserId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "repliedId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Email type." }, "repliedName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "repliesIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": true, "description": "IDs of records of the Email type." }, "repliesNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "repliesColumns": { "type": [ "object", "null" ], "readOnly": true, "description": "An {ID => object} map. Relationship column values.", "additionalProperties": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Draft", "Sending", "Sent", "Archived", "Failed" ] } } } }, "isSystem": { "type": "boolean", "readOnly": true }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "usersIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": true, "description": "IDs of records of the User type." }, "usersNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "usersColumns": { "type": [ "object", "null" ], "readOnly": true, "description": "An {ID => object} map. Relationship column values.", "additionalProperties": { "type": "object", "properties": { "inTrash": { "type": "boolean" }, "folderId": { "type": "string" }, "inArchive": { "type": "boolean" }, "isRead": { "type": "boolean" } } } }, "assignedUsersIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": true, "description": "IDs of records of the User type." }, "assignedUsersNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "inboundEmailsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": true, "description": "IDs of records of the InboundEmail type." }, "inboundEmailsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "emailAccountsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": true, "description": "IDs of records of the EmailAccount type." }, "emailAccountsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "icsContents": { "type": [ "string", "null" ], "readOnly": true, "description": "A multi-line text." }, "icsEventUid": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "icsEventDateStart": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "Specified if the 'icsEventDateStart' field is all-day." }, "icsEventDateStartDate": { "type": [ "string", "null" ], "format": "date", "readOnly": true }, "createdEventId": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record ID." }, "createdEventType": { "type": [ "string", "null" ], "readOnly": true, "description": "An entity type." }, "createdEventName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "groupFolderId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the GroupEmailFolder type." }, "groupFolderName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "groupStatusFolder": { "type": [ "string", "null" ], "readOnly": true, "enum": [ "Archive", "Trash" ] }, "accountId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "tasksIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": true, "description": "IDs of records of the Task type." }, "tasksNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "tasksColumns": { "type": [ "object", "null" ], "readOnly": true, "description": "An {ID => object} map. Relationship column values.", "additionalProperties": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Not Started", "Started", "Completed", "Canceled", "Deferred" ] } } } } } }, "Email_create": { "$ref": "#\/components\/schemas\/Email", "type": "object", "required": [ "name", "subject", "from", "to" ] }, "KnowledgeBaseArticle": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "status": { "type": "string", "readOnly": false, "enum": [ "Draft", "In Review", "Published", "Archived" ] }, "language": { "type": "string", "readOnly": false }, "type": { "type": "string", "readOnly": false, "enum": [ "Article" ] }, "portalsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Portal type." }, "portalsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "publishDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "expirationDate": { "type": [ "string", "null" ], "readOnly": false, "format": "date", "description": "A date." }, "order": { "type": [ "integer", "null" ], "readOnly": true }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "assignedUserId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "categoriesIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the KnowledgeBaseCategory type." }, "categoriesNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "body": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "bodyPlain": { "type": [ "string", "null" ], "readOnly": true, "description": "A multi-line text." } } }, "KnowledgeBaseArticle_create": { "$ref": "#\/components\/schemas\/KnowledgeBaseArticle", "type": "object", "required": [ "name" ] }, "Lead": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "salutationName": { "type": [ "string", "null" ], "readOnly": false, "enum": [ "Mr.", "Ms.", "Mrs.", "Dr." ] }, "firstName": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "lastName": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "title": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "status": { "type": "string", "readOnly": false, "enum": [ "New", "Assigned", "In Process", "Converted", "Recycled", "Dead" ] }, "source": { "type": [ "string", "null" ], "readOnly": false, "enum": [ "Call", "Email", "Existing Customer", "Partner", "Public Relations", "Web Site", "Campaign", "Other" ] }, "industry": { "type": [ "string", "null" ], "readOnly": false, "enum": [ "Advertising", "Aerospace", "Agriculture", "Apparel & Accessories", "Architecture", "Automotive", "Banking", "Biotechnology", "Building Materials & Equipment", "Chemical", "Construction", "Consulting", "Computer", "Culture", "Creative", "Defense", "Education", "Electronics", "Electric Power", "Energy", "Entertainment & Leisure", "Finance", "Food & Beverage", "Grocery", "Healthcare", "Hospitality", "Insurance", "Legal", "Manufacturing", "Mass Media", "Marketing", "Mining", "Music", "Publishing", "Petroleum", "Real Estate", "Retail", "Service", "Sports", "Software", "Support", "Shipping", "Travel", "Technology", "Telecommunications", "Television", "Transportation", "Testing, Inspection & Certification", "Venture Capital", "Wholesale", "Water" ] }, "opportunityAmount": { "readOnly": false, "type": [ "number", "null" ], "minimum": 0, "description": "A currency amount." }, "opportunityAmountCurrency": { "type": [ "string", "null" ], "enum": [ "USD" ], "readOnly": false, "description": "A code." }, "opportunityAmountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "website": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "addressStreet": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A multi-line text." }, "addressCity": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "addressState": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "addressCountry": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "addressPostalCode": { "type": [ "string", "null" ], "maxLength": 40, "readOnly": false, "description": "A one-line string." }, "emailAddress": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A primary email address." }, "emailAddressData": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "emailAddress": { "type": "string" }, "primary": { "type": "boolean" }, "optOut": { "type": "boolean" }, "invalid": { "type": "boolean" }, "lower": { "type": "string", "readOnly": true } }, "required": [ "emailAddress", "primary" ] }, "description": "Multiple email addresses" }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 36, "readOnly": false, "description": "A primary phone number." }, "phoneNumberData": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "phoneNumber": { "type": "string" }, "primary": { "type": "boolean" }, "optOut": { "type": "boolean" }, "invalid": { "type": "boolean" }, "type": { "type": "string", "enum": [ "Mobile", "Office", "Home", "Fax", "Other" ] } }, "required": [ "phoneNumber", "primary" ] }, "description": "Multiple phone numbers." }, "doNotCall": { "type": "boolean", "readOnly": false }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "convertedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "accountName": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "assignedUserId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "acceptanceStatusMeetings": { "type": "string", "readOnly": false }, "acceptanceStatusCalls": { "type": "string", "readOnly": false }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "campaignId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Campaign type." }, "campaignName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "createdAccountId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Account type." }, "createdAccountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "createdContactId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Contact type." }, "createdContactName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "createdOpportunityId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Opportunity type." }, "createdOpportunityName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "targetListsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the TargetList type." }, "targetListsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "targetListId": { "type": [ "string", "null" ], "readOnly": false }, "targetListName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "originalEmailId": { "type": [ "string", "null" ], "readOnly": false }, "originalEmailName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "middleName": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "emailAddressIsOptedOut": { "type": "boolean", "readOnly": false }, "emailAddressIsInvalid": { "type": "boolean", "readOnly": false }, "phoneNumberIsOptedOut": { "type": "boolean", "readOnly": false }, "phoneNumberIsInvalid": { "type": "boolean", "readOnly": false }, "streamUpdatedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." } } }, "Lead_create": { "$ref": "#\/components\/schemas\/Lead", "type": "object" }, "Meeting": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "status": { "type": "string", "readOnly": false, "enum": [ "Planned", "Held", "Not Held" ] }, "dateStart": { "type": "string", "readOnly": false, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "Specified if the 'dateStart' field is all-day." }, "dateStartDate": { "type": [ "string", "null" ], "format": "date", "readOnly": false }, "dateEnd": { "type": "string", "readOnly": false, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "Specified if the 'dateEnd' field is all-day." }, "dateEndDate": { "type": [ "string", "null" ], "format": "date", "readOnly": false }, "isAllDay": { "type": "boolean", "readOnly": false }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "parentId": { "type": [ "string", "null" ], "readOnly": false, "description": "A foreign record ID." }, "parentType": { "type": [ "string", "null" ], "readOnly": false, "enum": [ "Account", "Lead", "Contact", "Opportunity", "Case" ], "description": "An entity type." }, "parentName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "accountId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "uid": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A one-line string." }, "joinUrl": { "type": [ "string", "null" ], "maxLength": 320, "readOnly": true, "description": "A one-line string." }, "acceptanceStatus": { "type": "string", "readOnly": false, "enum": [ "None", "Accepted", "Tentative", "Declined" ] }, "usersIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the User type." }, "usersNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "usersColumns": { "type": [ "object", "null" ], "readOnly": false, "description": "An {ID => object} map. Relationship column values.", "additionalProperties": { "type": "object", "properties": { "status": { "type": "string" } } } }, "contactsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Contact type." }, "contactsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "contactsColumns": { "type": [ "object", "null" ], "readOnly": false, "description": "An {ID => object} map. Relationship column values.", "additionalProperties": { "type": "object", "properties": { "status": { "type": "string" } } } }, "leadsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Lead type." }, "leadsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "leadsColumns": { "type": [ "object", "null" ], "readOnly": false, "description": "An {ID => object} map. Relationship column values.", "additionalProperties": { "type": "object", "properties": { "status": { "type": "string" } } } }, "sourceEmailId": { "type": [ "string", "null" ], "readOnly": false }, "sourceEmailName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "assignedUserId": { "type": "string", "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "streamUpdatedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." } } }, "Meeting_create": { "$ref": "#\/components\/schemas\/Meeting", "type": "object", "required": [ "name", "dateStart", "dateEnd", "assignedUserId" ] }, "Opportunity": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "amount": { "readOnly": false, "type": "number", "minimum": 0, "description": "A currency amount." }, "amountCurrency": { "type": "string", "enum": [ "USD" ], "readOnly": false, "description": "A code." }, "amountConverted": { "type": [ "number", "null" ], "readOnly": true, "description": "A currency amount converted to the default currency." }, "amountWeightedConverted": { "type": [ "number", "null" ], "readOnly": true }, "accountId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "contactsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Contact type." }, "contactsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "contactsColumns": { "type": [ "object", "null" ], "readOnly": false, "description": "An {ID => object} map. Relationship column values.", "additionalProperties": { "type": "object", "properties": { "role": { "type": [ "string", "null" ], "enum": [ "Decision Maker", "Evaluator", "Influencer" ] } } } }, "contactId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Contact type." }, "contactName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "stage": { "type": "string", "readOnly": false, "enum": [ "Prospecting", "Qualification", "Proposal", "Negotiation", "Closed Won", "Closed Lost" ] }, "lastStage": { "type": "string", "readOnly": false }, "probability": { "type": [ "integer", "null" ], "readOnly": false, "minimum": 0, "maximum": 100 }, "leadSource": { "type": [ "string", "null" ], "readOnly": false, "enum": [ "Call", "Email", "Existing Customer", "Partner", "Public Relations", "Web Site", "Campaign", "Other" ] }, "closeDate": { "type": "string", "readOnly": false, "format": "date", "description": "A date." }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "campaignId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Campaign type." }, "campaignName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "originalLeadId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Lead type." }, "originalLeadName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "contactRole": { "type": [ "string", "null" ], "readOnly": false, "enum": [ "Decision Maker", "Evaluator", "Influencer" ] }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "assignedUserId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "streamUpdatedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." } } }, "Opportunity_create": { "$ref": "#\/components\/schemas\/Opportunity", "type": "object", "required": [ "name", "amount", "amountCurrency", "closeDate" ] }, "TargetList": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "categoryId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the TargetListCategory type." }, "categoryName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "entryCount": { "type": [ "integer", "null" ], "readOnly": true }, "optedOutCount": { "type": [ "integer", "null" ], "readOnly": true }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "sourceCampaignId": { "type": [ "string", "null" ], "readOnly": false }, "sourceCampaignName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "assignedUserId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "targetStatus": { "type": "string", "readOnly": true, "enum": [ "Listed", "Opted Out" ] }, "isOptedOut": { "type": "boolean", "readOnly": true } } }, "TargetList_create": { "$ref": "#\/components\/schemas\/TargetList", "type": "object", "required": [ "name" ] }, "Task": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "name": { "type": "string", "maxLength": 255, "readOnly": false, "description": "A one-line string." }, "status": { "type": "string", "readOnly": false, "enum": [ "Not Started", "Started", "Completed", "Canceled", "Deferred" ] }, "priority": { "type": "string", "readOnly": false, "enum": [ "Low", "Normal", "High", "Urgent" ] }, "dateStart": { "type": [ "string", "null" ], "readOnly": false, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "Specified if the 'dateStart' field is all-day." }, "dateStartDate": { "type": [ "string", "null" ], "format": "date", "readOnly": false }, "dateEnd": { "type": [ "string", "null" ], "readOnly": false, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "Specified if the 'dateEnd' field is all-day." }, "dateEndDate": { "type": [ "string", "null" ], "format": "date", "readOnly": false }, "dateCompleted": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "description": { "type": [ "string", "null" ], "readOnly": false, "description": "A multi-line text." }, "parentId": { "type": [ "string", "null" ], "readOnly": false, "description": "A foreign record ID." }, "parentType": { "type": [ "string", "null" ], "readOnly": false, "enum": [ "Account", "Contact", "Lead", "Opportunity", "Case" ], "description": "An entity type." }, "parentName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "accountId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Account type." }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "contactId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Contact type." }, "contactName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "modifiedById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "modifiedByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "assignedUserId": { "type": "string", "readOnly": false, "description": "An ID of the record of the User type." }, "assignedUserName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": false, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "streamUpdatedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." } } }, "Task_create": { "$ref": "#\/components\/schemas\/Task", "type": "object", "required": [ "name", "assignedUserId" ] }, "User": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "An ID." }, "userName": { "type": "string", "maxLength": 50, "readOnly": true, "description": "A one-line string." }, "type": { "type": "string", "readOnly": true, "enum": [ "regular", "admin", "portal", "system", "super-admin", "api" ] }, "authMethod": { "type": [ "string", "null" ], "readOnly": true, "enum": [ "ApiKey", "Hmac" ] }, "apiKey": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "secretKey": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "salutationName": { "type": [ "string", "null" ], "readOnly": false, "enum": [ "Mr.", "Ms.", "Mrs.", "Dr." ] }, "firstName": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "lastName": { "type": "string", "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "isActive": { "type": "boolean", "readOnly": true }, "title": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "position": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": true, "description": "A one-line string." }, "emailAddress": { "type": [ "string", "null" ], "maxLength": 255, "readOnly": true, "description": "A primary email address." }, "emailAddressData": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "emailAddress": { "type": "string" }, "primary": { "type": "boolean" }, "optOut": { "type": "boolean" }, "invalid": { "type": "boolean" }, "lower": { "type": "string", "readOnly": true } }, "required": [ "emailAddress", "primary" ] }, "description": "Multiple email addresses", "readOnly": true }, "phoneNumber": { "type": [ "string", "null" ], "maxLength": 36, "readOnly": false, "description": "A primary phone number." }, "phoneNumberData": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "phoneNumber": { "type": "string" }, "primary": { "type": "boolean" }, "optOut": { "type": "boolean" }, "invalid": { "type": "boolean" }, "type": { "type": "string", "enum": [ "Mobile", "Office", "Home", "Fax", "Other" ] } }, "required": [ "phoneNumber", "primary" ] }, "description": "Multiple phone numbers." }, "defaultTeamId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Team type." }, "defaultTeamName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "acceptanceStatusMeetings": { "type": "string", "readOnly": false }, "acceptanceStatusCalls": { "type": "string", "readOnly": false }, "teamsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": true, "description": "IDs of records of the Team type." }, "teamsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "teamsColumns": { "type": [ "object", "null" ], "readOnly": true, "description": "An {ID => object} map. Relationship column values.", "additionalProperties": { "type": "object", "properties": { "role": { "type": "string" } } } }, "rolesIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": true, "description": "IDs of records of the Role type." }, "rolesNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "portalsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": true, "description": "IDs of records of the Portal type." }, "portalsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "portalRolesIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": true, "description": "IDs of records of the PortalRole type." }, "portalRolesNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "contactId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the Contact type." }, "contactName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "accountsIds": { "type": [ "array", "null" ], "items": { "type": "string" }, "readOnly": true, "description": "IDs of records of the Account type." }, "accountsNames": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" }, "readOnly": true, "description": "An {ID => record name} map." }, "accountId": { "type": [ "string", "null" ], "readOnly": true }, "accountName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "avatarId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the Attachment type." }, "avatarName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "gender": { "type": [ "string", "null" ], "readOnly": false, "enum": [ "Male", "Female", "Neutral" ] }, "createdAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "modifiedAt": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "createdById": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the User type." }, "createdByName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "dashboardTemplateId": { "type": [ "string", "null" ], "readOnly": false, "description": "An ID of the record of the DashboardTemplate type." }, "dashboardTemplateName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "workingTimeCalendarId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the WorkingTimeCalendar type." }, "workingTimeCalendarName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "layoutSetId": { "type": [ "string", "null" ], "readOnly": true, "description": "An ID of the record of the LayoutSet type." }, "layoutSetName": { "type": [ "string", "null" ], "readOnly": true, "description": "A foreign record name." }, "lastAccess": { "type": [ "string", "null" ], "readOnly": true, "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "examples": [ "2026-11-29 12:34:56" ], "description": "A timestamp in UTC." }, "middleName": { "type": [ "string", "null" ], "maxLength": 100, "readOnly": false, "description": "A one-line string." }, "emailAddressIsOptedOut": { "type": "boolean", "readOnly": false }, "emailAddressIsInvalid": { "type": "boolean", "readOnly": false }, "phoneNumberIsOptedOut": { "type": "boolean", "readOnly": false }, "phoneNumberIsInvalid": { "type": "boolean", "readOnly": false } } }, "User_create": { "$ref": "#\/components\/schemas\/User", "type": "object", "required": [ "userName", "lastName" ] }, "whereItem": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "and", "or", "not", "subQueryNotIn", "subQueryIn", "expression", "in", "notIn", "equals", "notEquals", "on", "notOn", "like", "notLike", "startsWith", "endsWith", "contains", "notContains", "greaterThan", "lessThan", "greaterThanOrEquals", "lessThanOrEquals", "after", "before", "between", "ever", "any", "none", "isNull", "isNotNull", "isTrue", "isFalse", "today", "past", "future", "lastSevenDays", "lastXDays", "nextXDays", "olderThanXDays", "afterXDays", "currentMonth", "nextMonth", "lastMonth", "currentQuarter", "lastQuarter", "currentYear", "lastYear", "currentFiscalYear", "lastFiscalYear", "currentFiscalQuarter", "lastFiscalQuarter", "arrayAnyOf", "arrayNoneOf", "arrayAllOf", "arrayIsEmpty", "arrayIsNotEmpty", "linkedWith", "notLinkedWith", "linkedWithAll", "isLinked", "isNotLinked" ], "description": "An operator." }, "attribute": { "type": "string", "description": "An attribute or field." }, "value": { "oneOf": [ { "type": [ "string", "integer", "number", "boolean", "null" ] }, { "type": "array", "items": { "$ref": "#\/components\/schemas\/whereItem" } }, { "type": "array", "items": { "type": "string" } } ], "description": "A value. A scalar, or an array of strings." }, "dateTime": { "type": "boolean", "description": "Set true for date-time fields." }, "timeZone": { "type": "string", "description": "A time zone. For date-time fields." } }, "required": [ "type" ], "description": "A where item." } }, "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-Api-Key" } } }, "security": [ { "ApiKeyAuth": [] } ], "servers": [ { "url": "{siteUrl}\/api\/v1", "variables": { "siteUrl": { "default": "http:\/\/localhost", "description": "An URL of you Espo instance." } } } ] }