{"openapi": "3.1.0", "servers": [{"url": "https://us-east.api.pipelinersales.com/api/v100/rest/spaces/{space_id}"}, {"url": "https://eu-central.api.pipelinersales.com/api/v100/rest/spaces/{space_id}"}, {"url": "https://ca-central.api.pipelinersales.com/api/v100/rest/spaces/{space_id}"}, {"url": "https://ap-southeast.api.pipelinersales.com/api/v100/rest/spaces/{space_id}"}], "info": {"title": "Pipeliner Cloud API", "version": "100"}, "paths": {"/entities/Accounts/{id}": {"get": {"description": "Returns Account with given id", "operationId": "Accounts.get", "summary": "Accounts.get", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of Account to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Account data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Account"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Account with given id", "operationId": "Accounts.delete", "summary": "Accounts.delete", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of Account to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Account on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Account", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Account or Accounts with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Account to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Account on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Accounts.update", "summary": "Accounts.update", "tags": ["Account"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateAccountInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Account", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Account"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Accounts": {"get": {"description": "Returns all defined Accounts", "operationId": "Accounts.list", "summary": "Accounts.list", "tags": ["Account"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Accounts are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Accounts", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Account"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Account", "operationId": "Accounts.create", "summary": "Accounts.create", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Account on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Account", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createAccountInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Account", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Account"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Accounts/merge": {"post": {"description": "Merger multiple Accounts into master record.", "operationId": "Accounts.merge", "summary": "Accounts.merge", "tags": ["Account"], "parameters": [], "requestBody": {"description": "Entity .", "required": true, "content": {"application/json": {"schema": {"type": "object", "properties": {"master": {"$ref": "#/components/schemas/batchAccountInput"}, "secondary_ids": {"type": "array", "items": {"type": "string", "description": "An id of secondary Account.", "format": "uuid"}}}}}}}, "responses": {"200": {"description": "Merged entity", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Account"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Accounts/batch-delete": {"post": {"description": "Removes Accounts with given list of ids", "operationId": "Accounts.batch_delete", "summary": "Accounts.batch_delete", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Accounts on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Accounts. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Account to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Account.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Accounts/batch-modify": {"post": {"description": "Create or update an batch of Accounts", "operationId": "Accounts.batch_create_or_update", "summary": "Accounts.batch_create_or_update", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Accounts on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Accounts. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Account", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchAccountInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Accounts", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Accounts/batch-restore": {"post": {"description": "Restores Accounts with given list of ids", "operationId": "Accounts.batch_restore", "summary": "Accounts.batch_restore", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Accounts on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Accounts. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Account to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Account.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountDataExRelations/{id}": {"get": {"description": "Returns AccountDataExRelation with given id", "operationId": "AccountDataExRelations.get", "summary": "AccountDataExRelations.get", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of AccountDataExRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "AccountDataExRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountDataExRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountDataExRelations": {"get": {"description": "Returns all defined AccountDataExRelations", "operationId": "AccountDataExRelations.list", "summary": "AccountDataExRelations.list", "tags": ["Account"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted AccountDataExRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of AccountDataExRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/AccountDataExRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountKPIs/{id}": {"get": {"description": "Returns AccountKPI with given id", "operationId": "AccountKPIs.get", "summary": "AccountKPIs.get", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of AccountKPI to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "AccountKPI data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountKPI"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes AccountKPI with given id", "operationId": "AccountKPIs.delete", "summary": "AccountKPIs.delete", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of AccountKPI to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AccountKPI on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted AccountKPI", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies AccountKPI or AccountKPIs with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of AccountKPI to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AccountKPI on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "AccountKPIs.update", "summary": "AccountKPIs.update", "tags": ["Account"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateAccountKPIInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting AccountKPI", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountKPI"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountKPIs": {"get": {"description": "Returns all defined AccountKPIs", "operationId": "AccountKPIs.list", "summary": "AccountKPIs.list", "tags": ["Account"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted AccountKPIs are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of AccountKPIs", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/AccountKPI"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new AccountKPI", "operationId": "AccountKPIs.create", "summary": "AccountKPIs.create", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountKPI on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AccountKPI", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createAccountKPIInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created AccountKPI", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountKPI"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountKPIs/batch-delete": {"post": {"description": "Removes AccountKPIs with given list of ids", "operationId": "AccountKPIs.batch_delete", "summary": "AccountKPIs.batch_delete", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountKPIs on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountKPIs. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AccountKPI to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted AccountKPI.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountKPIs/batch-modify": {"post": {"description": "Create or update an batch of AccountKPIs", "operationId": "AccountKPIs.batch_create_or_update", "summary": "AccountKPIs.batch_create_or_update", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountKPIs on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountKPIs. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AccountKPI", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchAccountKPIInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated AccountKPIs", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountKPIs/batch-restore": {"post": {"description": "Restores AccountKPIs with given list of ids", "operationId": "AccountKPIs.batch_restore", "summary": "AccountKPIs.batch_restore", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountKPIs on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountKPIs. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AccountKPI to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored AccountKPI.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountProductPricings/{id}": {"get": {"description": "Returns AccountProductPricing with given id", "operationId": "AccountProductPricings.get", "summary": "AccountProductPricings.get", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of AccountProductPricing to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "AccountProductPricing data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountProductPricing"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes AccountProductPricing with given id", "operationId": "AccountProductPricings.delete", "summary": "AccountProductPricings.delete", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of AccountProductPricing to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AccountProductPricing on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted AccountProductPricing", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies AccountProductPricing or AccountProductPricings with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of AccountProductPricing to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AccountProductPricing on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "AccountProductPricings.update", "summary": "AccountProductPricings.update", "tags": ["Account"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateAccountProductPricingInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting AccountProductPricing", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountProductPricing"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountProductPricings": {"get": {"description": "Returns all defined AccountProductPricings", "operationId": "AccountProductPricings.list", "summary": "AccountProductPricings.list", "tags": ["Account"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted AccountProductPricings are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of AccountProductPricings", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/AccountProductPricing"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new AccountProductPricing", "operationId": "AccountProductPricings.create", "summary": "AccountProductPricings.create", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountProductPricing on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AccountProductPricing", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createAccountProductPricingInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created AccountProductPricing", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountProductPricing"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountProductPricings/batch-delete": {"post": {"description": "Removes AccountProductPricings with given list of ids", "operationId": "AccountProductPricings.batch_delete", "summary": "AccountProductPricings.batch_delete", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountProductPricings on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountProductPricings. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AccountProductPricing to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted AccountProductPricing.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountProductPricings/batch-modify": {"post": {"description": "Create or update an batch of AccountProductPricings", "operationId": "AccountProductPricings.batch_create_or_update", "summary": "AccountProductPricings.batch_create_or_update", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountProductPricings on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountProductPricings. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AccountProductPricing", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchAccountProductPricingInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated AccountProductPricings", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountProductPricings/batch-restore": {"post": {"description": "Restores AccountProductPricings with given list of ids", "operationId": "AccountProductPricings.batch_restore", "summary": "AccountProductPricings.batch_restore", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountProductPricings on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountProductPricings. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AccountProductPricing to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored AccountProductPricing.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountRelations/{id}": {"get": {"description": "Returns AccountRelation with given id", "operationId": "AccountRelations.get", "summary": "AccountRelations.get", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of AccountRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "AccountRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes AccountRelation with given id", "operationId": "AccountRelations.delete", "summary": "AccountRelations.delete", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of AccountRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AccountRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted AccountRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies AccountRelation or AccountRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of AccountRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AccountRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "AccountRelations.update", "summary": "AccountRelations.update", "tags": ["Account"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateAccountRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting AccountRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountRelations": {"get": {"description": "Returns all defined AccountRelations", "operationId": "AccountRelations.list", "summary": "AccountRelations.list", "tags": ["Account"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted AccountRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of AccountRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/AccountRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new AccountRelation", "operationId": "AccountRelations.create", "summary": "AccountRelations.create", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AccountRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createAccountRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created AccountRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountRelations/batch-delete": {"post": {"description": "Removes AccountRelations with given list of ids", "operationId": "AccountRelations.batch_delete", "summary": "AccountRelations.batch_delete", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AccountRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted AccountRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountRelations/batch-modify": {"post": {"description": "Create or update an batch of AccountRelations", "operationId": "AccountRelations.batch_create_or_update", "summary": "AccountRelations.batch_create_or_update", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AccountRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchAccountRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated AccountRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountRelations/batch-restore": {"post": {"description": "Restores AccountRelations with given list of ids", "operationId": "AccountRelations.batch_restore", "summary": "AccountRelations.batch_restore", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AccountRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored AccountRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountRelationLabels/{id}": {"get": {"description": "Returns AccountRelationLabel with given id", "operationId": "AccountRelationLabels.get", "summary": "AccountRelationLabels.get", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of AccountRelationLabel to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "AccountRelationLabel data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountRelationLabel"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes AccountRelationLabel with given id", "operationId": "AccountRelationLabels.delete", "summary": "AccountRelationLabels.delete", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of AccountRelationLabel to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AccountRelationLabel on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted AccountRelationLabel", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies AccountRelationLabel or AccountRelationLabels with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of AccountRelationLabel to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AccountRelationLabel on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "AccountRelationLabels.update", "summary": "AccountRelationLabels.update", "tags": ["Account"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateAccountRelationLabelInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting AccountRelationLabel", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountRelationLabel"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountRelationLabels": {"get": {"description": "Returns all defined AccountRelationLabels", "operationId": "AccountRelationLabels.list", "summary": "AccountRelationLabels.list", "tags": ["Account"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted AccountRelationLabels are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of AccountRelationLabels", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/AccountRelationLabel"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new AccountRelationLabel", "operationId": "AccountRelationLabels.create", "summary": "AccountRelationLabels.create", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountRelationLabel on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AccountRelationLabel", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createAccountRelationLabelInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created AccountRelationLabel", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountRelationLabel"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountRelationLabels/batch-delete": {"post": {"description": "Removes AccountRelationLabels with given list of ids", "operationId": "AccountRelationLabels.batch_delete", "summary": "AccountRelationLabels.batch_delete", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountRelationLabels on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountRelationLabels. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AccountRelationLabel to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted AccountRelationLabel.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountRelationLabels/batch-modify": {"post": {"description": "Create or update an batch of AccountRelationLabels", "operationId": "AccountRelationLabels.batch_create_or_update", "summary": "AccountRelationLabels.batch_create_or_update", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountRelationLabels on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountRelationLabels. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AccountRelationLabel", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchAccountRelationLabelInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated AccountRelationLabels", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountRelationLabels/batch-restore": {"post": {"description": "Restores AccountRelationLabels with given list of ids", "operationId": "AccountRelationLabels.batch_restore", "summary": "AccountRelationLabels.batch_restore", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountRelationLabels on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountRelationLabels. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AccountRelationLabel to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored AccountRelationLabel.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountRelationTypes/{id}": {"get": {"description": "Returns AccountRelationType with given id", "operationId": "AccountRelationTypes.get", "summary": "AccountRelationTypes.get", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of AccountRelationType to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "AccountRelationType data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountRelationType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes AccountRelationType with given id", "operationId": "AccountRelationTypes.delete", "summary": "AccountRelationTypes.delete", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of AccountRelationType to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AccountRelationType on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted AccountRelationType", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies AccountRelationType or AccountRelationTypes with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of AccountRelationType to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AccountRelationType on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "AccountRelationTypes.update", "summary": "AccountRelationTypes.update", "tags": ["Account"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateAccountRelationTypeInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting AccountRelationType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountRelationType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountRelationTypes": {"get": {"description": "Returns all defined AccountRelationTypes", "operationId": "AccountRelationTypes.list", "summary": "AccountRelationTypes.list", "tags": ["Account"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted AccountRelationTypes are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of AccountRelationTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/AccountRelationType"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new AccountRelationType", "operationId": "AccountRelationTypes.create", "summary": "AccountRelationTypes.create", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountRelationType on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AccountRelationType", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createAccountRelationTypeInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created AccountRelationType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountRelationType"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountRelationTypes/batch-delete": {"post": {"description": "Removes AccountRelationTypes with given list of ids", "operationId": "AccountRelationTypes.batch_delete", "summary": "AccountRelationTypes.batch_delete", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountRelationTypes on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountRelationTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AccountRelationType to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted AccountRelationType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountRelationTypes/batch-modify": {"post": {"description": "Create or update an batch of AccountRelationTypes", "operationId": "AccountRelationTypes.batch_create_or_update", "summary": "AccountRelationTypes.batch_create_or_update", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountRelationTypes on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountRelationTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AccountRelationType", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchAccountRelationTypeInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated AccountRelationTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountRelationTypes/batch-restore": {"post": {"description": "Restores AccountRelationTypes with given list of ids", "operationId": "AccountRelationTypes.batch_restore", "summary": "AccountRelationTypes.batch_restore", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountRelationTypes on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountRelationTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AccountRelationType to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored AccountRelationType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountRoles/{id}": {"get": {"description": "Returns AccountRole with given id", "operationId": "AccountRoles.get", "summary": "AccountRoles.get", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of AccountRole to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "AccountRole data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountRole"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes AccountRole with given id", "operationId": "AccountRoles.delete", "summary": "AccountRoles.delete", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of AccountRole to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AccountRole on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted AccountRole", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies AccountRole or AccountRoles with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of AccountRole to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AccountRole on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "AccountRoles.update", "summary": "AccountRoles.update", "tags": ["Account"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateAccountRoleInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting AccountRole", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountRole"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountRoles": {"get": {"description": "Returns all defined AccountRoles", "operationId": "AccountRoles.list", "summary": "AccountRoles.list", "tags": ["Account"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted AccountRoles are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of AccountRoles", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/AccountRole"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new AccountRole", "operationId": "AccountRoles.create", "summary": "AccountRoles.create", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountRole on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AccountRole", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createAccountRoleInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created AccountRole", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountRole"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountRoles/batch-delete": {"post": {"description": "Removes AccountRoles with given list of ids", "operationId": "AccountRoles.batch_delete", "summary": "AccountRoles.batch_delete", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountRoles on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountRoles. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AccountRole to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted AccountRole.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountRoles/batch-modify": {"post": {"description": "Create or update an batch of AccountRoles", "operationId": "AccountRoles.batch_create_or_update", "summary": "AccountRoles.batch_create_or_update", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountRoles on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountRoles. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AccountRole", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchAccountRoleInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated AccountRoles", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountRoles/batch-restore": {"post": {"description": "Restores AccountRoles with given list of ids", "operationId": "AccountRoles.batch_restore", "summary": "AccountRoles.batch_restore", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountRoles on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountRoles. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AccountRole to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored AccountRole.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountSharingClientRelations/{id}": {"get": {"description": "Returns AccountSharingClientRelation with given id", "operationId": "AccountSharingClientRelations.get", "summary": "AccountSharingClientRelations.get", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of AccountSharingClientRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "AccountSharingClientRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountSharingClientRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes AccountSharingClientRelation with given id", "operationId": "AccountSharingClientRelations.delete", "summary": "AccountSharingClientRelations.delete", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of AccountSharingClientRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AccountSharingClientRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted AccountSharingClientRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies AccountSharingClientRelation or AccountSharingClientRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of AccountSharingClientRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AccountSharingClientRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "AccountSharingClientRelations.update", "summary": "AccountSharingClientRelations.update", "tags": ["Account"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateAccountSharingClientRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting AccountSharingClientRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountSharingClientRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountSharingClientRelations": {"get": {"description": "Returns all defined AccountSharingClientRelations", "operationId": "AccountSharingClientRelations.list", "summary": "AccountSharingClientRelations.list", "tags": ["Account"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted AccountSharingClientRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of AccountSharingClientRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/AccountSharingClientRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new AccountSharingClientRelation", "operationId": "AccountSharingClientRelations.create", "summary": "AccountSharingClientRelations.create", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountSharingClientRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AccountSharingClientRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createAccountSharingClientRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created AccountSharingClientRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountSharingClientRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountSharingClientRelations/batch-delete": {"post": {"description": "Removes AccountSharingClientRelations with given list of ids", "operationId": "AccountSharingClientRelations.batch_delete", "summary": "AccountSharingClientRelations.batch_delete", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountSharingClientRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AccountSharingClientRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted AccountSharingClientRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountSharingClientRelations/batch-modify": {"post": {"description": "Create or update an batch of AccountSharingClientRelations", "operationId": "AccountSharingClientRelations.batch_create_or_update", "summary": "AccountSharingClientRelations.batch_create_or_update", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountSharingClientRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AccountSharingClientRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchAccountSharingClientRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated AccountSharingClientRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountSharingClientRelations/batch-restore": {"post": {"description": "Restores AccountSharingClientRelations with given list of ids", "operationId": "AccountSharingClientRelations.batch_restore", "summary": "AccountSharingClientRelations.batch_restore", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountSharingClientRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AccountSharingClientRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored AccountSharingClientRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountSharingSalesUnitRelations/{id}": {"get": {"description": "Returns AccountSharingSalesUnitRelation with given id", "operationId": "AccountSharingSalesUnitRelations.get", "summary": "AccountSharingSalesUnitRelations.get", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of AccountSharingSalesUnitRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "AccountSharingSalesUnitRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountSharingSalesUnitRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes AccountSharingSalesUnitRelation with given id", "operationId": "AccountSharingSalesUnitRelations.delete", "summary": "AccountSharingSalesUnitRelations.delete", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of AccountSharingSalesUnitRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AccountSharingSalesUnitRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted AccountSharingSalesUnitRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies AccountSharingSalesUnitRelation or AccountSharingSalesUnitRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of AccountSharingSalesUnitRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AccountSharingSalesUnitRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "AccountSharingSalesUnitRelations.update", "summary": "AccountSharingSalesUnitRelations.update", "tags": ["Account"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateAccountSharingSalesUnitRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting AccountSharingSalesUnitRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountSharingSalesUnitRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountSharingSalesUnitRelations": {"get": {"description": "Returns all defined AccountSharingSalesUnitRelations", "operationId": "AccountSharingSalesUnitRelations.list", "summary": "AccountSharingSalesUnitRelations.list", "tags": ["Account"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted AccountSharingSalesUnitRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of AccountSharingSalesUnitRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/AccountSharingSalesUnitRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new AccountSharingSalesUnitRelation", "operationId": "AccountSharingSalesUnitRelations.create", "summary": "AccountSharingSalesUnitRelations.create", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountSharingSalesUnitRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AccountSharingSalesUnitRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createAccountSharingSalesUnitRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created AccountSharingSalesUnitRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountSharingSalesUnitRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountSharingSalesUnitRelations/batch-delete": {"post": {"description": "Removes AccountSharingSalesUnitRelations with given list of ids", "operationId": "AccountSharingSalesUnitRelations.batch_delete", "summary": "AccountSharingSalesUnitRelations.batch_delete", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountSharingSalesUnitRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AccountSharingSalesUnitRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted AccountSharingSalesUnitRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountSharingSalesUnitRelations/batch-modify": {"post": {"description": "Create or update an batch of AccountSharingSalesUnitRelations", "operationId": "AccountSharingSalesUnitRelations.batch_create_or_update", "summary": "AccountSharingSalesUnitRelations.batch_create_or_update", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountSharingSalesUnitRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AccountSharingSalesUnitRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchAccountSharingSalesUnitRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated AccountSharingSalesUnitRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountSharingSalesUnitRelations/batch-restore": {"post": {"description": "Restores AccountSharingSalesUnitRelations with given list of ids", "operationId": "AccountSharingSalesUnitRelations.batch_restore", "summary": "AccountSharingSalesUnitRelations.batch_restore", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountSharingSalesUnitRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AccountSharingSalesUnitRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored AccountSharingSalesUnitRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountSocialRelations/{id}": {"get": {"description": "Returns AccountSocialRelation with given id", "operationId": "AccountSocialRelations.get", "summary": "AccountSocialRelations.get", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of AccountSocialRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "AccountSocialRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountSocialRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes AccountSocialRelation with given id", "operationId": "AccountSocialRelations.delete", "summary": "AccountSocialRelations.delete", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of AccountSocialRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AccountSocialRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted AccountSocialRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies AccountSocialRelation or AccountSocialRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of AccountSocialRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AccountSocialRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "AccountSocialRelations.update", "summary": "AccountSocialRelations.update", "tags": ["Account"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateAccountSocialRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting AccountSocialRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountSocialRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountSocialRelations": {"get": {"description": "Returns all defined AccountSocialRelations", "operationId": "AccountSocialRelations.list", "summary": "AccountSocialRelations.list", "tags": ["Account"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted AccountSocialRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of AccountSocialRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/AccountSocialRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new AccountSocialRelation", "operationId": "AccountSocialRelations.create", "summary": "AccountSocialRelations.create", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountSocialRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AccountSocialRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createAccountSocialRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created AccountSocialRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountSocialRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountSocialRelations/batch-delete": {"post": {"description": "Removes AccountSocialRelations with given list of ids", "operationId": "AccountSocialRelations.batch_delete", "summary": "AccountSocialRelations.batch_delete", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountSocialRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountSocialRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AccountSocialRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted AccountSocialRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountSocialRelations/batch-modify": {"post": {"description": "Create or update an batch of AccountSocialRelations", "operationId": "AccountSocialRelations.batch_create_or_update", "summary": "AccountSocialRelations.batch_create_or_update", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountSocialRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountSocialRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AccountSocialRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchAccountSocialRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated AccountSocialRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountSocialRelations/batch-restore": {"post": {"description": "Restores AccountSocialRelations with given list of ids", "operationId": "AccountSocialRelations.batch_restore", "summary": "AccountSocialRelations.batch_restore", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountSocialRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountSocialRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AccountSocialRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored AccountSocialRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountTypes/{id}": {"get": {"description": "Returns AccountType with given id", "operationId": "AccountTypes.get", "summary": "AccountTypes.get", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of AccountType to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "AccountType data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes AccountType with given id", "operationId": "AccountTypes.delete", "summary": "AccountTypes.delete", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of AccountType to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AccountType on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted AccountType", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies AccountType or AccountTypes with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of AccountType to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AccountType on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "AccountTypes.update", "summary": "AccountTypes.update", "tags": ["Account"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateAccountTypeInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting AccountType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountTypes": {"get": {"description": "Returns all defined AccountTypes", "operationId": "AccountTypes.list", "summary": "AccountTypes.list", "tags": ["Account"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted AccountTypes are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of AccountTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/AccountType"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new AccountType", "operationId": "AccountTypes.create", "summary": "AccountTypes.create", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountType on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AccountType", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createAccountTypeInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created AccountType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AccountType"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountTypes/batch-delete": {"post": {"description": "Removes AccountTypes with given list of ids", "operationId": "AccountTypes.batch_delete", "summary": "AccountTypes.batch_delete", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountTypes on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AccountType to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted AccountType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountTypes/batch-modify": {"post": {"description": "Create or update an batch of AccountTypes", "operationId": "AccountTypes.batch_create_or_update", "summary": "AccountTypes.batch_create_or_update", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountTypes on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AccountType", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchAccountTypeInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated AccountTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AccountTypes/batch-restore": {"post": {"description": "Restores AccountTypes with given list of ids", "operationId": "AccountTypes.batch_restore", "summary": "AccountTypes.batch_restore", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AccountTypes on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AccountTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AccountType to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored AccountType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Activities/{id}": {"get": {"description": "Returns Activity with given id", "operationId": "Activities.get", "summary": "Activities.get", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of Activity to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Activity data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Activity"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Activities": {"get": {"description": "Returns all defined Activities", "operationId": "Activities.list", "summary": "Activities.list", "tags": ["Activity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Activities are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Activities", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Activity"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ActivityComments/{id}": {"get": {"description": "Returns ActivityComment with given id", "operationId": "ActivityComments.get", "summary": "ActivityComments.get", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of ActivityComment to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ActivityComment data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ActivityComment"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ActivityComment with given id", "operationId": "ActivityComments.delete", "summary": "ActivityComments.delete", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of ActivityComment to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ActivityComment on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ActivityComment", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ActivityComment or ActivityComments with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ActivityComment to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ActivityComment on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ActivityComments.update", "summary": "ActivityComments.update", "tags": ["Activity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateActivityCommentInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ActivityComment", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ActivityComment"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ActivityComments": {"get": {"description": "Returns all defined ActivityComments", "operationId": "ActivityComments.list", "summary": "ActivityComments.list", "tags": ["Activity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ActivityComments are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ActivityComments", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ActivityComment"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ActivityComment", "operationId": "ActivityComments.create", "summary": "ActivityComments.create", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ActivityComment on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ActivityComment", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createActivityCommentInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ActivityComment", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ActivityComment"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ActivityComments/batch-delete": {"post": {"description": "Removes ActivityComments with given list of ids", "operationId": "ActivityComments.batch_delete", "summary": "ActivityComments.batch_delete", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ActivityComments on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ActivityComments. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ActivityComment to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ActivityComment.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ActivityComments/batch-modify": {"post": {"description": "Create or update an batch of ActivityComments", "operationId": "ActivityComments.batch_create_or_update", "summary": "ActivityComments.batch_create_or_update", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ActivityComments on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ActivityComments. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ActivityComment", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchActivityCommentInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ActivityComments", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ActivityComments/batch-restore": {"post": {"description": "Restores ActivityComments with given list of ids", "operationId": "ActivityComments.batch_restore", "summary": "ActivityComments.batch_restore", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ActivityComments on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ActivityComments. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ActivityComment to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ActivityComment.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ActivityDataExRelations/{id}": {"get": {"description": "Returns ActivityDataExRelation with given id", "operationId": "ActivityDataExRelations.get", "summary": "ActivityDataExRelations.get", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of ActivityDataExRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ActivityDataExRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ActivityDataExRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ActivityDataExRelations": {"get": {"description": "Returns all defined ActivityDataExRelations", "operationId": "ActivityDataExRelations.list", "summary": "ActivityDataExRelations.list", "tags": ["Activity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ActivityDataExRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ActivityDataExRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ActivityDataExRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ActivityKPIs/{id}": {"get": {"description": "Returns ActivityKPI with given id", "operationId": "ActivityKPIs.get", "summary": "ActivityKPIs.get", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of ActivityKPI to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ActivityKPI data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ActivityKPI"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ActivityKPI with given id", "operationId": "ActivityKPIs.delete", "summary": "ActivityKPIs.delete", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of ActivityKPI to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ActivityKPI on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ActivityKPI", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ActivityKPI or ActivityKPIs with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ActivityKPI to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ActivityKPI on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ActivityKPIs.update", "summary": "ActivityKPIs.update", "tags": ["Activity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateActivityKPIInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ActivityKPI", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ActivityKPI"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ActivityKPIs": {"get": {"description": "Returns all defined ActivityKPIs", "operationId": "ActivityKPIs.list", "summary": "ActivityKPIs.list", "tags": ["Activity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ActivityKPIs are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ActivityKPIs", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ActivityKPI"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ActivityKPI", "operationId": "ActivityKPIs.create", "summary": "ActivityKPIs.create", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ActivityKPI on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ActivityKPI", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createActivityKPIInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ActivityKPI", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ActivityKPI"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ActivityKPIs/batch-delete": {"post": {"description": "Removes ActivityKPIs with given list of ids", "operationId": "ActivityKPIs.batch_delete", "summary": "ActivityKPIs.batch_delete", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ActivityKPIs on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ActivityKPIs. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ActivityKPI to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ActivityKPI.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ActivityKPIs/batch-modify": {"post": {"description": "Create or update an batch of ActivityKPIs", "operationId": "ActivityKPIs.batch_create_or_update", "summary": "ActivityKPIs.batch_create_or_update", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ActivityKPIs on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ActivityKPIs. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ActivityKPI", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchActivityKPIInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ActivityKPIs", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ActivityKPIs/batch-restore": {"post": {"description": "Restores ActivityKPIs with given list of ids", "operationId": "ActivityKPIs.batch_restore", "summary": "ActivityKPIs.batch_restore", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ActivityKPIs on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ActivityKPIs. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ActivityKPI to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ActivityKPI.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ActivityRelations/{id}": {"get": {"description": "Returns ActivityRelation with given id", "operationId": "ActivityRelations.get", "summary": "ActivityRelations.get", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of ActivityRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ActivityRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ActivityRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ActivityRelation with given id", "operationId": "ActivityRelations.delete", "summary": "ActivityRelations.delete", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of ActivityRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ActivityRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ActivityRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ActivityRelation or ActivityRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ActivityRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ActivityRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ActivityRelations.update", "summary": "ActivityRelations.update", "tags": ["Activity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateActivityRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ActivityRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ActivityRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ActivityRelations": {"get": {"description": "Returns all defined ActivityRelations", "operationId": "ActivityRelations.list", "summary": "ActivityRelations.list", "tags": ["Activity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ActivityRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ActivityRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ActivityRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ActivityRelation", "operationId": "ActivityRelations.create", "summary": "ActivityRelations.create", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ActivityRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ActivityRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createActivityRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ActivityRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ActivityRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ActivityRelations/batch-delete": {"post": {"description": "Removes ActivityRelations with given list of ids", "operationId": "ActivityRelations.batch_delete", "summary": "ActivityRelations.batch_delete", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ActivityRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ActivityRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ActivityRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ActivityRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ActivityRelations/batch-modify": {"post": {"description": "Create or update an batch of ActivityRelations", "operationId": "ActivityRelations.batch_create_or_update", "summary": "ActivityRelations.batch_create_or_update", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ActivityRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ActivityRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ActivityRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchActivityRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ActivityRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ActivityRelations/batch-restore": {"post": {"description": "Restores ActivityRelations with given list of ids", "operationId": "ActivityRelations.batch_restore", "summary": "ActivityRelations.batch_restore", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ActivityRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ActivityRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ActivityRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ActivityRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedAccountTypes/{id}": {"get": {"description": "Returns AllowedAccountType with given id", "operationId": "AllowedAccountTypes.get", "summary": "AllowedAccountTypes.get", "tags": ["MasterRight"], "parameters": [{"name": "id", "in": "path", "description": "ID of AllowedAccountType to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "AllowedAccountType data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AllowedAccountType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes AllowedAccountType with given id", "operationId": "AllowedAccountTypes.delete", "summary": "AllowedAccountTypes.delete", "tags": ["MasterRight"], "parameters": [{"name": "id", "in": "path", "description": "ID of AllowedAccountType to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedAccountType on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted AllowedAccountType", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies AllowedAccountType or AllowedAccountTypes with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of AllowedAccountType to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedAccountType on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "AllowedAccountTypes.update", "summary": "AllowedAccountTypes.update", "tags": ["MasterRight"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateAllowedAccountTypeInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting AllowedAccountType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AllowedAccountType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedAccountTypes": {"get": {"description": "Returns all defined AllowedAccountTypes", "operationId": "AllowedAccountTypes.list", "summary": "AllowedAccountTypes.list", "tags": ["MasterRight"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted AllowedAccountTypes are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of AllowedAccountTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/AllowedAccountType"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new AllowedAccountType", "operationId": "AllowedAccountTypes.create", "summary": "AllowedAccountTypes.create", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedAccountType on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AllowedAccountType", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createAllowedAccountTypeInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created AllowedAccountType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AllowedAccountType"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedAccountTypes/batch-delete": {"post": {"description": "Removes AllowedAccountTypes with given list of ids", "operationId": "AllowedAccountTypes.batch_delete", "summary": "AllowedAccountTypes.batch_delete", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedAccountTypes on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AllowedAccountTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AllowedAccountType to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted AllowedAccountType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedAccountTypes/batch-modify": {"post": {"description": "Create or update an batch of AllowedAccountTypes", "operationId": "AllowedAccountTypes.batch_create_or_update", "summary": "AllowedAccountTypes.batch_create_or_update", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedAccountTypes on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AllowedAccountTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AllowedAccountType", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchAllowedAccountTypeInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated AllowedAccountTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedAccountTypes/batch-restore": {"post": {"description": "Restores AllowedAccountTypes with given list of ids", "operationId": "AllowedAccountTypes.batch_restore", "summary": "AllowedAccountTypes.batch_restore", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedAccountTypes on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AllowedAccountTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AllowedAccountType to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored AllowedAccountType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedCompanyEmails/{id}": {"get": {"description": "Returns AllowedCompanyEmail with given id", "operationId": "AllowedCompanyEmails.get", "summary": "AllowedCompanyEmails.get", "tags": ["MasterRight"], "parameters": [{"name": "id", "in": "path", "description": "ID of AllowedCompanyEmail to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "AllowedCompanyEmail data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AllowedCompanyEmail"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes AllowedCompanyEmail with given id", "operationId": "AllowedCompanyEmails.delete", "summary": "AllowedCompanyEmails.delete", "tags": ["MasterRight"], "parameters": [{"name": "id", "in": "path", "description": "ID of AllowedCompanyEmail to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedCompanyEmail on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted AllowedCompanyEmail", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies AllowedCompanyEmail or AllowedCompanyEmails with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of AllowedCompanyEmail to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedCompanyEmail on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "AllowedCompanyEmails.update", "summary": "AllowedCompanyEmails.update", "tags": ["MasterRight"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateAllowedCompanyEmailInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting AllowedCompanyEmail", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AllowedCompanyEmail"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedCompanyEmails": {"get": {"description": "Returns all defined AllowedCompanyEmails", "operationId": "AllowedCompanyEmails.list", "summary": "AllowedCompanyEmails.list", "tags": ["MasterRight"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted AllowedCompanyEmails are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of AllowedCompanyEmails", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/AllowedCompanyEmail"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new AllowedCompanyEmail", "operationId": "AllowedCompanyEmails.create", "summary": "AllowedCompanyEmails.create", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedCompanyEmail on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AllowedCompanyEmail", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createAllowedCompanyEmailInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created AllowedCompanyEmail", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AllowedCompanyEmail"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedCompanyEmails/batch-delete": {"post": {"description": "Removes AllowedCompanyEmails with given list of ids", "operationId": "AllowedCompanyEmails.batch_delete", "summary": "AllowedCompanyEmails.batch_delete", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedCompanyEmails on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AllowedCompanyEmails. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AllowedCompanyEmail to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted AllowedCompanyEmail.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedCompanyEmails/batch-modify": {"post": {"description": "Create or update an batch of AllowedCompanyEmails", "operationId": "AllowedCompanyEmails.batch_create_or_update", "summary": "AllowedCompanyEmails.batch_create_or_update", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedCompanyEmails on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AllowedCompanyEmails. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AllowedCompanyEmail", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchAllowedCompanyEmailInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated AllowedCompanyEmails", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedCompanyEmails/batch-restore": {"post": {"description": "Restores AllowedCompanyEmails with given list of ids", "operationId": "AllowedCompanyEmails.batch_restore", "summary": "AllowedCompanyEmails.batch_restore", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedCompanyEmails on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AllowedCompanyEmails. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AllowedCompanyEmail to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored AllowedCompanyEmail.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedCompanyPhones/{id}": {"get": {"description": "Returns AllowedCompanyPhone with given id", "operationId": "AllowedCompanyPhones.get", "summary": "AllowedCompanyPhones.get", "tags": ["MasterRight"], "parameters": [{"name": "id", "in": "path", "description": "ID of AllowedCompanyPhone to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "AllowedCompanyPhone data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AllowedCompanyPhone"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes AllowedCompanyPhone with given id", "operationId": "AllowedCompanyPhones.delete", "summary": "AllowedCompanyPhones.delete", "tags": ["MasterRight"], "parameters": [{"name": "id", "in": "path", "description": "ID of AllowedCompanyPhone to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedCompanyPhone on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted AllowedCompanyPhone", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies AllowedCompanyPhone or AllowedCompanyPhones with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of AllowedCompanyPhone to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedCompanyPhone on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "AllowedCompanyPhones.update", "summary": "AllowedCompanyPhones.update", "tags": ["MasterRight"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateAllowedCompanyPhoneInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting AllowedCompanyPhone", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AllowedCompanyPhone"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedCompanyPhones": {"get": {"description": "Returns all defined AllowedCompanyPhones", "operationId": "AllowedCompanyPhones.list", "summary": "AllowedCompanyPhones.list", "tags": ["MasterRight"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted AllowedCompanyPhones are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of AllowedCompanyPhones", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/AllowedCompanyPhone"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new AllowedCompanyPhone", "operationId": "AllowedCompanyPhones.create", "summary": "AllowedCompanyPhones.create", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedCompanyPhone on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AllowedCompanyPhone", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createAllowedCompanyPhoneInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created AllowedCompanyPhone", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AllowedCompanyPhone"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedCompanyPhones/batch-delete": {"post": {"description": "Removes AllowedCompanyPhones with given list of ids", "operationId": "AllowedCompanyPhones.batch_delete", "summary": "AllowedCompanyPhones.batch_delete", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedCompanyPhones on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AllowedCompanyPhones. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AllowedCompanyPhone to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted AllowedCompanyPhone.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedCompanyPhones/batch-modify": {"post": {"description": "Create or update an batch of AllowedCompanyPhones", "operationId": "AllowedCompanyPhones.batch_create_or_update", "summary": "AllowedCompanyPhones.batch_create_or_update", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedCompanyPhones on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AllowedCompanyPhones. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AllowedCompanyPhone", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchAllowedCompanyPhoneInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated AllowedCompanyPhones", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedCompanyPhones/batch-restore": {"post": {"description": "Restores AllowedCompanyPhones with given list of ids", "operationId": "AllowedCompanyPhones.batch_restore", "summary": "AllowedCompanyPhones.batch_restore", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedCompanyPhones on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AllowedCompanyPhones. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AllowedCompanyPhone to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored AllowedCompanyPhone.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedContactTypes/{id}": {"get": {"description": "Returns AllowedContactType with given id", "operationId": "AllowedContactTypes.get", "summary": "AllowedContactTypes.get", "tags": ["MasterRight"], "parameters": [{"name": "id", "in": "path", "description": "ID of AllowedContactType to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "AllowedContactType data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AllowedContactType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes AllowedContactType with given id", "operationId": "AllowedContactTypes.delete", "summary": "AllowedContactTypes.delete", "tags": ["MasterRight"], "parameters": [{"name": "id", "in": "path", "description": "ID of AllowedContactType to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedContactType on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted AllowedContactType", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies AllowedContactType or AllowedContactTypes with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of AllowedContactType to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedContactType on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "AllowedContactTypes.update", "summary": "AllowedContactTypes.update", "tags": ["MasterRight"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateAllowedContactTypeInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting AllowedContactType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AllowedContactType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedContactTypes": {"get": {"description": "Returns all defined AllowedContactTypes", "operationId": "AllowedContactTypes.list", "summary": "AllowedContactTypes.list", "tags": ["MasterRight"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted AllowedContactTypes are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of AllowedContactTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/AllowedContactType"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new AllowedContactType", "operationId": "AllowedContactTypes.create", "summary": "AllowedContactTypes.create", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedContactType on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AllowedContactType", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createAllowedContactTypeInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created AllowedContactType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AllowedContactType"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedContactTypes/batch-delete": {"post": {"description": "Removes AllowedContactTypes with given list of ids", "operationId": "AllowedContactTypes.batch_delete", "summary": "AllowedContactTypes.batch_delete", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedContactTypes on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AllowedContactTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AllowedContactType to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted AllowedContactType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedContactTypes/batch-modify": {"post": {"description": "Create or update an batch of AllowedContactTypes", "operationId": "AllowedContactTypes.batch_create_or_update", "summary": "AllowedContactTypes.batch_create_or_update", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedContactTypes on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AllowedContactTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AllowedContactType", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchAllowedContactTypeInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated AllowedContactTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedContactTypes/batch-restore": {"post": {"description": "Restores AllowedContactTypes with given list of ids", "operationId": "AllowedContactTypes.batch_restore", "summary": "AllowedContactTypes.batch_restore", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedContactTypes on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AllowedContactTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AllowedContactType to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored AllowedContactType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedLeadTypes/{id}": {"get": {"description": "Returns AllowedLeadType with given id", "operationId": "AllowedLeadTypes.get", "summary": "AllowedLeadTypes.get", "tags": ["MasterRight"], "parameters": [{"name": "id", "in": "path", "description": "ID of AllowedLeadType to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "AllowedLeadType data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AllowedLeadType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes AllowedLeadType with given id", "operationId": "AllowedLeadTypes.delete", "summary": "AllowedLeadTypes.delete", "tags": ["MasterRight"], "parameters": [{"name": "id", "in": "path", "description": "ID of AllowedLeadType to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedLeadType on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted AllowedLeadType", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies AllowedLeadType or AllowedLeadTypes with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of AllowedLeadType to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedLeadType on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "AllowedLeadTypes.update", "summary": "AllowedLeadTypes.update", "tags": ["MasterRight"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateAllowedLeadTypeInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting AllowedLeadType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AllowedLeadType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedLeadTypes": {"get": {"description": "Returns all defined AllowedLeadTypes", "operationId": "AllowedLeadTypes.list", "summary": "AllowedLeadTypes.list", "tags": ["MasterRight"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted AllowedLeadTypes are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of AllowedLeadTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/AllowedLeadType"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new AllowedLeadType", "operationId": "AllowedLeadTypes.create", "summary": "AllowedLeadTypes.create", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedLeadType on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AllowedLeadType", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createAllowedLeadTypeInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created AllowedLeadType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AllowedLeadType"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedLeadTypes/batch-delete": {"post": {"description": "Removes AllowedLeadTypes with given list of ids", "operationId": "AllowedLeadTypes.batch_delete", "summary": "AllowedLeadTypes.batch_delete", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedLeadTypes on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AllowedLeadTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AllowedLeadType to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted AllowedLeadType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedLeadTypes/batch-modify": {"post": {"description": "Create or update an batch of AllowedLeadTypes", "operationId": "AllowedLeadTypes.batch_create_or_update", "summary": "AllowedLeadTypes.batch_create_or_update", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedLeadTypes on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AllowedLeadTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AllowedLeadType", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchAllowedLeadTypeInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated AllowedLeadTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedLeadTypes/batch-restore": {"post": {"description": "Restores AllowedLeadTypes with given list of ids", "operationId": "AllowedLeadTypes.batch_restore", "summary": "AllowedLeadTypes.batch_restore", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedLeadTypes on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AllowedLeadTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AllowedLeadType to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored AllowedLeadType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedPipelines/{id}": {"get": {"description": "Returns AllowedPipeline with given id", "operationId": "AllowedPipelines.get", "summary": "AllowedPipelines.get", "tags": ["MasterRight"], "parameters": [{"name": "id", "in": "path", "description": "ID of AllowedPipeline to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "AllowedPipeline data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AllowedPipeline"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes AllowedPipeline with given id", "operationId": "AllowedPipelines.delete", "summary": "AllowedPipelines.delete", "tags": ["MasterRight"], "parameters": [{"name": "id", "in": "path", "description": "ID of AllowedPipeline to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedPipeline on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted AllowedPipeline", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies AllowedPipeline or AllowedPipelines with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of AllowedPipeline to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedPipeline on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "AllowedPipelines.update", "summary": "AllowedPipelines.update", "tags": ["MasterRight"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateAllowedPipelineInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting AllowedPipeline", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AllowedPipeline"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedPipelines": {"get": {"description": "Returns all defined AllowedPipelines", "operationId": "AllowedPipelines.list", "summary": "AllowedPipelines.list", "tags": ["MasterRight"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted AllowedPipelines are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of AllowedPipelines", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/AllowedPipeline"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new AllowedPipeline", "operationId": "AllowedPipelines.create", "summary": "AllowedPipelines.create", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedPipeline on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AllowedPipeline", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createAllowedPipelineInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created AllowedPipeline", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AllowedPipeline"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedPipelines/batch-delete": {"post": {"description": "Removes AllowedPipelines with given list of ids", "operationId": "AllowedPipelines.batch_delete", "summary": "AllowedPipelines.batch_delete", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedPipelines on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AllowedPipelines. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AllowedPipeline to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted AllowedPipeline.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedPipelines/batch-modify": {"post": {"description": "Create or update an batch of AllowedPipelines", "operationId": "AllowedPipelines.batch_create_or_update", "summary": "AllowedPipelines.batch_create_or_update", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedPipelines on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AllowedPipelines. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AllowedPipeline", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchAllowedPipelineInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated AllowedPipelines", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedPipelines/batch-restore": {"post": {"description": "Restores AllowedPipelines with given list of ids", "operationId": "AllowedPipelines.batch_restore", "summary": "AllowedPipelines.batch_restore", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedPipelines on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AllowedPipelines. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AllowedPipeline to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored AllowedPipeline.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedQuoteTypes/{id}": {"get": {"description": "Returns AllowedQuoteType with given id", "operationId": "AllowedQuoteTypes.get", "summary": "AllowedQuoteTypes.get", "tags": ["MasterRight"], "parameters": [{"name": "id", "in": "path", "description": "ID of AllowedQuoteType to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "AllowedQuoteType data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AllowedQuoteType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes AllowedQuoteType with given id", "operationId": "AllowedQuoteTypes.delete", "summary": "AllowedQuoteTypes.delete", "tags": ["MasterRight"], "parameters": [{"name": "id", "in": "path", "description": "ID of AllowedQuoteType to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedQuoteType on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted AllowedQuoteType", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies AllowedQuoteType or AllowedQuoteTypes with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of AllowedQuoteType to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedQuoteType on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "AllowedQuoteTypes.update", "summary": "AllowedQuoteTypes.update", "tags": ["MasterRight"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateAllowedQuoteTypeInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting AllowedQuoteType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AllowedQuoteType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedQuoteTypes": {"get": {"description": "Returns all defined AllowedQuoteTypes", "operationId": "AllowedQuoteTypes.list", "summary": "AllowedQuoteTypes.list", "tags": ["MasterRight"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted AllowedQuoteTypes are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of AllowedQuoteTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/AllowedQuoteType"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new AllowedQuoteType", "operationId": "AllowedQuoteTypes.create", "summary": "AllowedQuoteTypes.create", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedQuoteType on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AllowedQuoteType", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createAllowedQuoteTypeInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created AllowedQuoteType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AllowedQuoteType"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedQuoteTypes/batch-delete": {"post": {"description": "Removes AllowedQuoteTypes with given list of ids", "operationId": "AllowedQuoteTypes.batch_delete", "summary": "AllowedQuoteTypes.batch_delete", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedQuoteTypes on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AllowedQuoteTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AllowedQuoteType to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted AllowedQuoteType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedQuoteTypes/batch-modify": {"post": {"description": "Create or update an batch of AllowedQuoteTypes", "operationId": "AllowedQuoteTypes.batch_create_or_update", "summary": "AllowedQuoteTypes.batch_create_or_update", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedQuoteTypes on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AllowedQuoteTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AllowedQuoteType", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchAllowedQuoteTypeInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated AllowedQuoteTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AllowedQuoteTypes/batch-restore": {"post": {"description": "Restores AllowedQuoteTypes with given list of ids", "operationId": "AllowedQuoteTypes.batch_restore", "summary": "AllowedQuoteTypes.batch_restore", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AllowedQuoteTypes on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AllowedQuoteTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AllowedQuoteType to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored AllowedQuoteType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ApiAccesses/{id}": {"get": {"description": "Returns ApiAccess with given id", "operationId": "ApiAccesses.get", "summary": "ApiAccesses.get", "tags": ["Api"], "parameters": [{"name": "id", "in": "path", "description": "ID of ApiAccess to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ApiAccess data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ApiAccess"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ApiAccesses": {"get": {"description": "Returns all defined ApiAccesses", "operationId": "ApiAccesses.list", "summary": "ApiAccesses.list", "tags": ["Api"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ApiAccesses are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ApiAccesses", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ApiAccess"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Appointments/{id}": {"get": {"description": "Returns Appointment with given id", "operationId": "Appointments.get", "summary": "Appointments.get", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of Appointment to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Appointment data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Appointment"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Appointment with given id", "operationId": "Appointments.delete", "summary": "Appointments.delete", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of Appointment to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Appointment on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Appointment", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Appointment or Appointments with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Appointment to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Appointment on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Appointments.update", "summary": "Appointments.update", "tags": ["Activity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateAppointmentInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Appointment", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Appointment"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Appointments": {"get": {"description": "Returns all defined Appointments", "operationId": "Appointments.list", "summary": "Appointments.list", "tags": ["Activity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Appointments are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Appointments", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Appointment"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Appointment", "operationId": "Appointments.create", "summary": "Appointments.create", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Appointment on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Appointment", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createAppointmentInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Appointment", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Appointment"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Appointments/batch-delete": {"post": {"description": "Removes Appointments with given list of ids", "operationId": "Appointments.batch_delete", "summary": "Appointments.batch_delete", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Appointments on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Appointments. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Appointment to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Appointment.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Appointments/batch-modify": {"post": {"description": "Create or update an batch of Appointments", "operationId": "Appointments.batch_create_or_update", "summary": "Appointments.batch_create_or_update", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Appointments on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Appointments. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Appointment", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchAppointmentInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Appointments", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Appointments/batch-restore": {"post": {"description": "Restores Appointments with given list of ids", "operationId": "Appointments.batch_restore", "summary": "Appointments.batch_restore", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Appointments on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Appointments. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Appointment to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Appointment.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AppointmentClientInviteesRelations/{id}": {"get": {"description": "Returns AppointmentClientInviteesRelation with given id", "operationId": "AppointmentClientInviteesRelations.get", "summary": "AppointmentClientInviteesRelations.get", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of AppointmentClientInviteesRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "AppointmentClientInviteesRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AppointmentClientInviteesRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes AppointmentClientInviteesRelation with given id", "operationId": "AppointmentClientInviteesRelations.delete", "summary": "AppointmentClientInviteesRelations.delete", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of AppointmentClientInviteesRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentClientInviteesRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted AppointmentClientInviteesRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies AppointmentClientInviteesRelation or AppointmentClientInviteesRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of AppointmentClientInviteesRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentClientInviteesRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "AppointmentClientInviteesRelations.update", "summary": "AppointmentClientInviteesRelations.update", "tags": ["Activity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateAppointmentClientInviteesRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting AppointmentClientInviteesRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AppointmentClientInviteesRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AppointmentClientInviteesRelations": {"get": {"description": "Returns all defined AppointmentClientInviteesRelations", "operationId": "AppointmentClientInviteesRelations.list", "summary": "AppointmentClientInviteesRelations.list", "tags": ["Activity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted AppointmentClientInviteesRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of AppointmentClientInviteesRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/AppointmentClientInviteesRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new AppointmentClientInviteesRelation", "operationId": "AppointmentClientInviteesRelations.create", "summary": "AppointmentClientInviteesRelations.create", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentClientInviteesRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AppointmentClientInviteesRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createAppointmentClientInviteesRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created AppointmentClientInviteesRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AppointmentClientInviteesRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AppointmentClientInviteesRelations/batch-delete": {"post": {"description": "Removes AppointmentClientInviteesRelations with given list of ids", "operationId": "AppointmentClientInviteesRelations.batch_delete", "summary": "AppointmentClientInviteesRelations.batch_delete", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentClientInviteesRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AppointmentClientInviteesRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AppointmentClientInviteesRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted AppointmentClientInviteesRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AppointmentClientInviteesRelations/batch-modify": {"post": {"description": "Create or update an batch of AppointmentClientInviteesRelations", "operationId": "AppointmentClientInviteesRelations.batch_create_or_update", "summary": "AppointmentClientInviteesRelations.batch_create_or_update", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentClientInviteesRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AppointmentClientInviteesRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AppointmentClientInviteesRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchAppointmentClientInviteesRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated AppointmentClientInviteesRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AppointmentClientInviteesRelations/batch-restore": {"post": {"description": "Restores AppointmentClientInviteesRelations with given list of ids", "operationId": "AppointmentClientInviteesRelations.batch_restore", "summary": "AppointmentClientInviteesRelations.batch_restore", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentClientInviteesRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AppointmentClientInviteesRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AppointmentClientInviteesRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored AppointmentClientInviteesRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AppointmentContactInviteesRelations/{id}": {"get": {"description": "Returns AppointmentContactInviteesRelation with given id", "operationId": "AppointmentContactInviteesRelations.get", "summary": "AppointmentContactInviteesRelations.get", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of AppointmentContactInviteesRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "AppointmentContactInviteesRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AppointmentContactInviteesRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes AppointmentContactInviteesRelation with given id", "operationId": "AppointmentContactInviteesRelations.delete", "summary": "AppointmentContactInviteesRelations.delete", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of AppointmentContactInviteesRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentContactInviteesRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted AppointmentContactInviteesRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies AppointmentContactInviteesRelation or AppointmentContactInviteesRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of AppointmentContactInviteesRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentContactInviteesRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "AppointmentContactInviteesRelations.update", "summary": "AppointmentContactInviteesRelations.update", "tags": ["Activity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateAppointmentContactInviteesRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting AppointmentContactInviteesRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AppointmentContactInviteesRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AppointmentContactInviteesRelations": {"get": {"description": "Returns all defined AppointmentContactInviteesRelations", "operationId": "AppointmentContactInviteesRelations.list", "summary": "AppointmentContactInviteesRelations.list", "tags": ["Activity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted AppointmentContactInviteesRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of AppointmentContactInviteesRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/AppointmentContactInviteesRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new AppointmentContactInviteesRelation", "operationId": "AppointmentContactInviteesRelations.create", "summary": "AppointmentContactInviteesRelations.create", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentContactInviteesRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AppointmentContactInviteesRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createAppointmentContactInviteesRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created AppointmentContactInviteesRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AppointmentContactInviteesRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AppointmentContactInviteesRelations/batch-delete": {"post": {"description": "Removes AppointmentContactInviteesRelations with given list of ids", "operationId": "AppointmentContactInviteesRelations.batch_delete", "summary": "AppointmentContactInviteesRelations.batch_delete", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentContactInviteesRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AppointmentContactInviteesRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AppointmentContactInviteesRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted AppointmentContactInviteesRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AppointmentContactInviteesRelations/batch-modify": {"post": {"description": "Create or update an batch of AppointmentContactInviteesRelations", "operationId": "AppointmentContactInviteesRelations.batch_create_or_update", "summary": "AppointmentContactInviteesRelations.batch_create_or_update", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentContactInviteesRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AppointmentContactInviteesRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AppointmentContactInviteesRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchAppointmentContactInviteesRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated AppointmentContactInviteesRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AppointmentContactInviteesRelations/batch-restore": {"post": {"description": "Restores AppointmentContactInviteesRelations with given list of ids", "operationId": "AppointmentContactInviteesRelations.batch_restore", "summary": "AppointmentContactInviteesRelations.batch_restore", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentContactInviteesRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AppointmentContactInviteesRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AppointmentContactInviteesRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored AppointmentContactInviteesRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AppointmentReminders/{id}": {"get": {"description": "Returns AppointmentReminder with given id", "operationId": "AppointmentReminders.get", "summary": "AppointmentReminders.get", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of AppointmentReminder to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "AppointmentReminder data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AppointmentReminder"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes AppointmentReminder with given id", "operationId": "AppointmentReminders.delete", "summary": "AppointmentReminders.delete", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of AppointmentReminder to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentReminder on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted AppointmentReminder", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies AppointmentReminder or AppointmentReminders with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of AppointmentReminder to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentReminder on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "AppointmentReminders.update", "summary": "AppointmentReminders.update", "tags": ["Activity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateAppointmentReminderInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting AppointmentReminder", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AppointmentReminder"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AppointmentReminders": {"get": {"description": "Returns all defined AppointmentReminders", "operationId": "AppointmentReminders.list", "summary": "AppointmentReminders.list", "tags": ["Activity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted AppointmentReminders are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of AppointmentReminders", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/AppointmentReminder"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new AppointmentReminder", "operationId": "AppointmentReminders.create", "summary": "AppointmentReminders.create", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentReminder on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AppointmentReminder", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createAppointmentReminderInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created AppointmentReminder", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AppointmentReminder"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AppointmentReminders/batch-delete": {"post": {"description": "Removes AppointmentReminders with given list of ids", "operationId": "AppointmentReminders.batch_delete", "summary": "AppointmentReminders.batch_delete", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentReminders on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AppointmentReminders. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AppointmentReminder to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted AppointmentReminder.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AppointmentReminders/batch-modify": {"post": {"description": "Create or update an batch of AppointmentReminders", "operationId": "AppointmentReminders.batch_create_or_update", "summary": "AppointmentReminders.batch_create_or_update", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentReminders on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AppointmentReminders. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AppointmentReminder", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchAppointmentReminderInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated AppointmentReminders", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AppointmentReminders/batch-restore": {"post": {"description": "Restores AppointmentReminders with given list of ids", "operationId": "AppointmentReminders.batch_restore", "summary": "AppointmentReminders.batch_restore", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentReminders on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AppointmentReminders. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AppointmentReminder to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored AppointmentReminder.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AppointmentSchedules/{id}": {"get": {"description": "Returns AppointmentSchedule with given id", "operationId": "AppointmentSchedules.get", "summary": "AppointmentSchedules.get", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of AppointmentSchedule to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "AppointmentSchedule data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AppointmentSchedule"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes AppointmentSchedule with given id", "operationId": "AppointmentSchedules.delete", "summary": "AppointmentSchedules.delete", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of AppointmentSchedule to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentSchedule on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted AppointmentSchedule", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies AppointmentSchedule or AppointmentSchedules with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of AppointmentSchedule to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentSchedule on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "AppointmentSchedules.update", "summary": "AppointmentSchedules.update", "tags": ["Activity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateAppointmentScheduleInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting AppointmentSchedule", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AppointmentSchedule"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AppointmentSchedules": {"get": {"description": "Returns all defined AppointmentSchedules", "operationId": "AppointmentSchedules.list", "summary": "AppointmentSchedules.list", "tags": ["Activity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted AppointmentSchedules are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of AppointmentSchedules", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/AppointmentSchedule"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new AppointmentSchedule", "operationId": "AppointmentSchedules.create", "summary": "AppointmentSchedules.create", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentSchedule on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AppointmentSchedule", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createAppointmentScheduleInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created AppointmentSchedule", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AppointmentSchedule"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AppointmentSchedules/batch-delete": {"post": {"description": "Removes AppointmentSchedules with given list of ids", "operationId": "AppointmentSchedules.batch_delete", "summary": "AppointmentSchedules.batch_delete", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentSchedules on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AppointmentSchedules. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AppointmentSchedule to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted AppointmentSchedule.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AppointmentSchedules/batch-modify": {"post": {"description": "Create or update an batch of AppointmentSchedules", "operationId": "AppointmentSchedules.batch_create_or_update", "summary": "AppointmentSchedules.batch_create_or_update", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentSchedules on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AppointmentSchedules. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AppointmentSchedule", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchAppointmentScheduleInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated AppointmentSchedules", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AppointmentSchedules/batch-restore": {"post": {"description": "Restores AppointmentSchedules with given list of ids", "operationId": "AppointmentSchedules.batch_restore", "summary": "AppointmentSchedules.batch_restore", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentSchedules on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AppointmentSchedules. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AppointmentSchedule to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored AppointmentSchedule.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AppointmentTypes/{id}": {"get": {"description": "Returns AppointmentType with given id", "operationId": "AppointmentTypes.get", "summary": "AppointmentTypes.get", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of AppointmentType to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "AppointmentType data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AppointmentType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes AppointmentType with given id", "operationId": "AppointmentTypes.delete", "summary": "AppointmentTypes.delete", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of AppointmentType to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentType on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted AppointmentType", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies AppointmentType or AppointmentTypes with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of AppointmentType to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentType on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "AppointmentTypes.update", "summary": "AppointmentTypes.update", "tags": ["Activity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateAppointmentTypeInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting AppointmentType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AppointmentType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AppointmentTypes": {"get": {"description": "Returns all defined AppointmentTypes", "operationId": "AppointmentTypes.list", "summary": "AppointmentTypes.list", "tags": ["Activity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted AppointmentTypes are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of AppointmentTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/AppointmentType"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new AppointmentType", "operationId": "AppointmentTypes.create", "summary": "AppointmentTypes.create", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentType on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AppointmentType", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createAppointmentTypeInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created AppointmentType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/AppointmentType"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AppointmentTypes/batch-delete": {"post": {"description": "Removes AppointmentTypes with given list of ids", "operationId": "AppointmentTypes.batch_delete", "summary": "AppointmentTypes.batch_delete", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentTypes on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AppointmentTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AppointmentType to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted AppointmentType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AppointmentTypes/batch-modify": {"post": {"description": "Create or update an batch of AppointmentTypes", "operationId": "AppointmentTypes.batch_create_or_update", "summary": "AppointmentTypes.batch_create_or_update", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentTypes on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AppointmentTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new AppointmentType", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchAppointmentTypeInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated AppointmentTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/AppointmentTypes/batch-restore": {"post": {"description": "Restores AppointmentTypes with given list of ids", "operationId": "AppointmentTypes.batch_restore", "summary": "AppointmentTypes.batch_restore", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of AppointmentTypes on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for AppointmentTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity AppointmentType to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored AppointmentType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Approvals/{id}": {"get": {"description": "Returns Approval with given id", "operationId": "Approvals.get", "summary": "Approvals.get", "tags": ["Approval"], "parameters": [{"name": "id", "in": "path", "description": "ID of Approval to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Approval data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Approval"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Approval with given id", "operationId": "Approvals.delete", "summary": "Approvals.delete", "tags": ["Approval"], "parameters": [{"name": "id", "in": "path", "description": "ID of Approval to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Approval on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Approval", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Approval or Approvals with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Approval to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Approval on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Approvals.update", "summary": "Approvals.update", "tags": ["Approval"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateApprovalInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Approval", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Approval"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Approvals": {"get": {"description": "Returns all defined Approvals", "operationId": "Approvals.list", "summary": "Approvals.list", "tags": ["Approval"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Approvals are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Approvals", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Approval"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Approval", "operationId": "Approvals.create", "summary": "Approvals.create", "tags": ["Approval"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Approval on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Approval", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createApprovalInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Approval", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Approval"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Approvals/batch-delete": {"post": {"description": "Removes Approvals with given list of ids", "operationId": "Approvals.batch_delete", "summary": "Approvals.batch_delete", "tags": ["Approval"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Approvals on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Approvals. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Approval to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Approval.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Approvals/batch-modify": {"post": {"description": "Create or update an batch of Approvals", "operationId": "Approvals.batch_create_or_update", "summary": "Approvals.batch_create_or_update", "tags": ["Approval"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Approvals on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Approvals. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Approval", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchApprovalInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Approvals", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Approvals/batch-restore": {"post": {"description": "Restores Approvals with given list of ids", "operationId": "Approvals.batch_restore", "summary": "Approvals.batch_restore", "tags": ["Approval"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Approvals on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Approvals. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Approval to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Approval.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ApprovalApprovers/{id}": {"get": {"description": "Returns ApprovalApprover with given id", "operationId": "ApprovalApprovers.get", "summary": "ApprovalApprovers.get", "tags": ["Approval"], "parameters": [{"name": "id", "in": "path", "description": "ID of ApprovalApprover to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ApprovalApprover data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ApprovalApprover"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ApprovalApprover with given id", "operationId": "ApprovalApprovers.delete", "summary": "ApprovalApprovers.delete", "tags": ["Approval"], "parameters": [{"name": "id", "in": "path", "description": "ID of ApprovalApprover to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ApprovalApprover on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ApprovalApprover", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ApprovalApprover or ApprovalApprovers with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ApprovalApprover to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ApprovalApprover on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ApprovalApprovers.update", "summary": "ApprovalApprovers.update", "tags": ["Approval"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateApprovalApproverInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ApprovalApprover", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ApprovalApprover"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ApprovalApprovers": {"get": {"description": "Returns all defined ApprovalApprovers", "operationId": "ApprovalApprovers.list", "summary": "ApprovalApprovers.list", "tags": ["Approval"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ApprovalApprovers are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ApprovalApprovers", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ApprovalApprover"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ApprovalApprover", "operationId": "ApprovalApprovers.create", "summary": "ApprovalApprovers.create", "tags": ["Approval"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ApprovalApprover on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ApprovalApprover", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createApprovalApproverInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ApprovalApprover", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ApprovalApprover"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ApprovalApprovers/batch-delete": {"post": {"description": "Removes ApprovalApprovers with given list of ids", "operationId": "ApprovalApprovers.batch_delete", "summary": "ApprovalApprovers.batch_delete", "tags": ["Approval"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ApprovalApprovers on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ApprovalApprovers. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ApprovalApprover to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ApprovalApprover.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ApprovalApprovers/batch-modify": {"post": {"description": "Create or update an batch of ApprovalApprovers", "operationId": "ApprovalApprovers.batch_create_or_update", "summary": "ApprovalApprovers.batch_create_or_update", "tags": ["Approval"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ApprovalApprovers on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ApprovalApprovers. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ApprovalApprover", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchApprovalApproverInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ApprovalApprovers", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ApprovalApprovers/batch-restore": {"post": {"description": "Restores ApprovalApprovers with given list of ids", "operationId": "ApprovalApprovers.batch_restore", "summary": "ApprovalApprovers.batch_restore", "tags": ["Approval"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ApprovalApprovers on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ApprovalApprovers. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ApprovalApprover to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ApprovalApprover.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ApprovalProcesses/{id}": {"get": {"description": "Returns ApprovalProcess with given id", "operationId": "ApprovalProcesses.get", "summary": "ApprovalProcesses.get", "tags": ["Approval"], "parameters": [{"name": "id", "in": "path", "description": "ID of ApprovalProcess to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ApprovalProcess data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ApprovalProcess"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ApprovalProcess with given id", "operationId": "ApprovalProcesses.delete", "summary": "ApprovalProcesses.delete", "tags": ["Approval"], "parameters": [{"name": "id", "in": "path", "description": "ID of ApprovalProcess to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ApprovalProcess on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ApprovalProcess", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ApprovalProcess or ApprovalProcesses with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ApprovalProcess to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ApprovalProcess on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ApprovalProcesses.update", "summary": "ApprovalProcesses.update", "tags": ["Approval"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateApprovalProcessInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ApprovalProcess", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ApprovalProcess"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ApprovalProcesses": {"get": {"description": "Returns all defined ApprovalProcesses", "operationId": "ApprovalProcesses.list", "summary": "ApprovalProcesses.list", "tags": ["Approval"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ApprovalProcesses are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ApprovalProcesses", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ApprovalProcess"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ApprovalProcess", "operationId": "ApprovalProcesses.create", "summary": "ApprovalProcesses.create", "tags": ["Approval"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ApprovalProcess on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ApprovalProcess", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createApprovalProcessInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ApprovalProcess", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ApprovalProcess"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ApprovalProcesses/batch-delete": {"post": {"description": "Removes ApprovalProcesses with given list of ids", "operationId": "ApprovalProcesses.batch_delete", "summary": "ApprovalProcesses.batch_delete", "tags": ["Approval"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ApprovalProcesses on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ApprovalProcesses. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ApprovalProcess to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ApprovalProcess.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ApprovalProcesses/batch-modify": {"post": {"description": "Create or update an batch of ApprovalProcesses", "operationId": "ApprovalProcesses.batch_create_or_update", "summary": "ApprovalProcesses.batch_create_or_update", "tags": ["Approval"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ApprovalProcesses on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ApprovalProcesses. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ApprovalProcess", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchApprovalProcessInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ApprovalProcesses", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ApprovalProcesses/batch-restore": {"post": {"description": "Restores ApprovalProcesses with given list of ids", "operationId": "ApprovalProcesses.batch_restore", "summary": "ApprovalProcesses.batch_restore", "tags": ["Approval"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ApprovalProcesses on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ApprovalProcesses. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ApprovalProcess to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ApprovalProcess.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ApprovalProcessActivityLogLines/{id}": {"get": {"description": "Returns ApprovalProcessActivityLogLine with given id", "operationId": "ApprovalProcessActivityLogLines.get", "summary": "ApprovalProcessActivityLogLines.get", "tags": ["Approval"], "parameters": [{"name": "id", "in": "path", "description": "ID of ApprovalProcessActivityLogLine to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ApprovalProcessActivityLogLine data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ApprovalProcessActivityLogLine"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ApprovalProcessActivityLogLine with given id", "operationId": "ApprovalProcessActivityLogLines.delete", "summary": "ApprovalProcessActivityLogLines.delete", "tags": ["Approval"], "parameters": [{"name": "id", "in": "path", "description": "ID of ApprovalProcessActivityLogLine to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ApprovalProcessActivityLogLine on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ApprovalProcessActivityLogLine", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ApprovalProcessActivityLogLine or ApprovalProcessActivityLogLines with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ApprovalProcessActivityLogLine to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ApprovalProcessActivityLogLine on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ApprovalProcessActivityLogLines.update", "summary": "ApprovalProcessActivityLogLines.update", "tags": ["Approval"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateApprovalProcessActivityLogLineInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ApprovalProcessActivityLogLine", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ApprovalProcessActivityLogLine"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ApprovalProcessActivityLogLines": {"get": {"description": "Returns all defined ApprovalProcessActivityLogLines", "operationId": "ApprovalProcessActivityLogLines.list", "summary": "ApprovalProcessActivityLogLines.list", "tags": ["Approval"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ApprovalProcessActivityLogLines are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ApprovalProcessActivityLogLines", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ApprovalProcessActivityLogLine"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ApprovalProcessActivityLogLine", "operationId": "ApprovalProcessActivityLogLines.create", "summary": "ApprovalProcessActivityLogLines.create", "tags": ["Approval"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ApprovalProcessActivityLogLine on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ApprovalProcessActivityLogLine", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createApprovalProcessActivityLogLineInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ApprovalProcessActivityLogLine", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ApprovalProcessActivityLogLine"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ApprovalProcessActivityLogLines/batch-delete": {"post": {"description": "Removes ApprovalProcessActivityLogLines with given list of ids", "operationId": "ApprovalProcessActivityLogLines.batch_delete", "summary": "ApprovalProcessActivityLogLines.batch_delete", "tags": ["Approval"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ApprovalProcessActivityLogLines on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ApprovalProcessActivityLogLines. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ApprovalProcessActivityLogLine to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ApprovalProcessActivityLogLine.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ApprovalProcessActivityLogLines/batch-modify": {"post": {"description": "Create or update an batch of ApprovalProcessActivityLogLines", "operationId": "ApprovalProcessActivityLogLines.batch_create_or_update", "summary": "ApprovalProcessActivityLogLines.batch_create_or_update", "tags": ["Approval"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ApprovalProcessActivityLogLines on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ApprovalProcessActivityLogLines. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ApprovalProcessActivityLogLine", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchApprovalProcessActivityLogLineInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ApprovalProcessActivityLogLines", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ApprovalProcessActivityLogLines/batch-restore": {"post": {"description": "Restores ApprovalProcessActivityLogLines with given list of ids", "operationId": "ApprovalProcessActivityLogLines.batch_restore", "summary": "ApprovalProcessActivityLogLines.batch_restore", "tags": ["Approval"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ApprovalProcessActivityLogLines on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ApprovalProcessActivityLogLines. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ApprovalProcessActivityLogLine to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ApprovalProcessActivityLogLine.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Calls/{id}": {"get": {"description": "Returns Call with given id", "operationId": "Calls.get", "summary": "Calls.get", "tags": ["Call"], "parameters": [{"name": "id", "in": "path", "description": "ID of Call to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Call data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Call"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Call with given id", "operationId": "Calls.delete", "summary": "Calls.delete", "tags": ["Call"], "parameters": [{"name": "id", "in": "path", "description": "ID of Call to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Call on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Call", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Call or Calls with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Call to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Call on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Calls.update", "summary": "Calls.update", "tags": ["Call"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateCallInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Call", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Call"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Calls": {"get": {"description": "Returns all defined Calls", "operationId": "Calls.list", "summary": "Calls.list", "tags": ["Call"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Calls are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Calls", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Call"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Call", "operationId": "Calls.create", "summary": "Calls.create", "tags": ["Call"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Call on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Call", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createCallInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Call", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Call"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Calls/batch-delete": {"post": {"description": "Removes Calls with given list of ids", "operationId": "Calls.batch_delete", "summary": "Calls.batch_delete", "tags": ["Call"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Calls on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Calls. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Call to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Call.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Calls/batch-modify": {"post": {"description": "Create or update an batch of Calls", "operationId": "Calls.batch_create_or_update", "summary": "Calls.batch_create_or_update", "tags": ["Call"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Calls on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Calls. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Call", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchCallInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Calls", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Calls/batch-restore": {"post": {"description": "Restores Calls with given list of ids", "operationId": "Calls.batch_restore", "summary": "Calls.batch_restore", "tags": ["Call"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Calls on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Calls. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Call to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Call.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ChatConversations/{id}": {"get": {"description": "Returns ChatConversation with given id", "operationId": "ChatConversations.get", "summary": "ChatConversations.get", "tags": ["Chat"], "parameters": [{"name": "id", "in": "path", "description": "ID of ChatConversation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ChatConversation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ChatConversation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ChatConversation with given id", "operationId": "ChatConversations.delete", "summary": "ChatConversations.delete", "tags": ["Chat"], "parameters": [{"name": "id", "in": "path", "description": "ID of ChatConversation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ChatConversation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ChatConversation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ChatConversation or ChatConversations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ChatConversation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ChatConversation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ChatConversations.update", "summary": "ChatConversations.update", "tags": ["Chat"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateChatConversationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ChatConversation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ChatConversation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ChatConversations": {"get": {"description": "Returns all defined ChatConversations", "operationId": "ChatConversations.list", "summary": "ChatConversations.list", "tags": ["Chat"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ChatConversations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ChatConversations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ChatConversation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ChatConversation", "operationId": "ChatConversations.create", "summary": "ChatConversations.create", "tags": ["Chat"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ChatConversation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ChatConversation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createChatConversationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ChatConversation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ChatConversation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ChatConversations/batch-delete": {"post": {"description": "Removes ChatConversations with given list of ids", "operationId": "ChatConversations.batch_delete", "summary": "ChatConversations.batch_delete", "tags": ["Chat"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ChatConversations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ChatConversations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ChatConversation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ChatConversation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ChatConversations/batch-modify": {"post": {"description": "Create or update an batch of ChatConversations", "operationId": "ChatConversations.batch_create_or_update", "summary": "ChatConversations.batch_create_or_update", "tags": ["Chat"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ChatConversations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ChatConversations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ChatConversation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchChatConversationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ChatConversations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ChatConversations/batch-restore": {"post": {"description": "Restores ChatConversations with given list of ids", "operationId": "ChatConversations.batch_restore", "summary": "ChatConversations.batch_restore", "tags": ["Chat"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ChatConversations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ChatConversations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ChatConversation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ChatConversation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Clients/{id}": {"get": {"description": "Returns Client with given id", "operationId": "Clients.get", "summary": "Clients.get", "tags": ["Client"], "parameters": [{"name": "id", "in": "path", "description": "ID of Client to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Client data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Client"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Client with given id", "operationId": "Clients.delete", "summary": "Clients.delete", "tags": ["Client"], "parameters": [{"name": "id", "in": "path", "description": "ID of Client to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Client on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Client", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Client or Clients with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Client to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Client on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Clients.update", "summary": "Clients.update", "tags": ["Client"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateClientInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Client", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Client"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Clients": {"get": {"description": "Returns all defined Clients", "operationId": "Clients.list", "summary": "Clients.list", "tags": ["Client"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Clients are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Clients", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Client"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Client", "operationId": "Clients.create", "summary": "Clients.create", "tags": ["Client"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Client on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Client", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createClientInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Client", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Client"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Clients/batch-delete": {"post": {"description": "Removes Clients with given list of ids", "operationId": "Clients.batch_delete", "summary": "Clients.batch_delete", "tags": ["Client"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Clients on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Clients. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Client to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Client.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Clients/batch-modify": {"post": {"description": "Create or update an batch of Clients", "operationId": "Clients.batch_create_or_update", "summary": "Clients.batch_create_or_update", "tags": ["Client"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Clients on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Clients. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Client", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchClientInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Clients", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Clients/batch-restore": {"post": {"description": "Restores Clients with given list of ids", "operationId": "Clients.batch_restore", "summary": "Clients.batch_restore", "tags": ["Client"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Clients on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Clients. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Client to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Client.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ClientExcludedOppties/{id}": {"get": {"description": "Returns ClientExcludedOppty with given id", "operationId": "ClientExcludedOppties.get", "summary": "ClientExcludedOppties.get", "tags": ["Client"], "parameters": [{"name": "id", "in": "path", "description": "ID of ClientExcludedOppty to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ClientExcludedOppty data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ClientExcludedOppty"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ClientExcludedOppty with given id", "operationId": "ClientExcludedOppties.delete", "summary": "ClientExcludedOppties.delete", "tags": ["Client"], "parameters": [{"name": "id", "in": "path", "description": "ID of ClientExcludedOppty to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ClientExcludedOppty on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ClientExcludedOppty", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ClientExcludedOppty or ClientExcludedOppties with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ClientExcludedOppty to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ClientExcludedOppty on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ClientExcludedOppties.update", "summary": "ClientExcludedOppties.update", "tags": ["Client"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateClientExcludedOpptyInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ClientExcludedOppty", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ClientExcludedOppty"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ClientExcludedOppties": {"get": {"description": "Returns all defined ClientExcludedOppties", "operationId": "ClientExcludedOppties.list", "summary": "ClientExcludedOppties.list", "tags": ["Client"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ClientExcludedOppties are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ClientExcludedOppties", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ClientExcludedOppty"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ClientExcludedOppty", "operationId": "ClientExcludedOppties.create", "summary": "ClientExcludedOppties.create", "tags": ["Client"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ClientExcludedOppty on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ClientExcludedOppty", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createClientExcludedOpptyInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ClientExcludedOppty", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ClientExcludedOppty"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ClientExcludedOppties/batch-delete": {"post": {"description": "Removes ClientExcludedOppties with given list of ids", "operationId": "ClientExcludedOppties.batch_delete", "summary": "ClientExcludedOppties.batch_delete", "tags": ["Client"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ClientExcludedOppties on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ClientExcludedOppties. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ClientExcludedOppty to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ClientExcludedOppty.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ClientExcludedOppties/batch-modify": {"post": {"description": "Create or update an batch of ClientExcludedOppties", "operationId": "ClientExcludedOppties.batch_create_or_update", "summary": "ClientExcludedOppties.batch_create_or_update", "tags": ["Client"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ClientExcludedOppties on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ClientExcludedOppties. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ClientExcludedOppty", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchClientExcludedOpptyInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ClientExcludedOppties", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ClientExcludedOppties/batch-restore": {"post": {"description": "Restores ClientExcludedOppties with given list of ids", "operationId": "ClientExcludedOppties.batch_restore", "summary": "ClientExcludedOppties.batch_restore", "tags": ["Client"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ClientExcludedOppties on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ClientExcludedOppties. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ClientExcludedOppty to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ClientExcludedOppty.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ClientFavorites/{id}": {"get": {"description": "Returns ClientFavorite with given id", "operationId": "ClientFavorites.get", "summary": "ClientFavorites.get", "tags": ["Client"], "parameters": [{"name": "id", "in": "path", "description": "ID of ClientFavorite to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ClientFavorite data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ClientFavorite"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ClientFavorite with given id", "operationId": "ClientFavorites.delete", "summary": "ClientFavorites.delete", "tags": ["Client"], "parameters": [{"name": "id", "in": "path", "description": "ID of ClientFavorite to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ClientFavorite on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ClientFavorite", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ClientFavorite or ClientFavorites with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ClientFavorite to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ClientFavorite on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ClientFavorites.update", "summary": "ClientFavorites.update", "tags": ["Client"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateClientFavoriteInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ClientFavorite", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ClientFavorite"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ClientFavorites": {"get": {"description": "Returns all defined ClientFavorites", "operationId": "ClientFavorites.list", "summary": "ClientFavorites.list", "tags": ["Client"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ClientFavorites are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ClientFavorites", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ClientFavorite"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ClientFavorite", "operationId": "ClientFavorites.create", "summary": "ClientFavorites.create", "tags": ["Client"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ClientFavorite on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ClientFavorite", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createClientFavoriteInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ClientFavorite", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ClientFavorite"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ClientFavorites/batch-delete": {"post": {"description": "Removes ClientFavorites with given list of ids", "operationId": "ClientFavorites.batch_delete", "summary": "ClientFavorites.batch_delete", "tags": ["Client"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ClientFavorites on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ClientFavorites. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ClientFavorite to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ClientFavorite.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ClientFavorites/batch-modify": {"post": {"description": "Create or update an batch of ClientFavorites", "operationId": "ClientFavorites.batch_create_or_update", "summary": "ClientFavorites.batch_create_or_update", "tags": ["Client"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ClientFavorites on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ClientFavorites. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ClientFavorite", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchClientFavoriteInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ClientFavorites", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ClientFavorites/batch-restore": {"post": {"description": "Restores ClientFavorites with given list of ids", "operationId": "ClientFavorites.batch_restore", "summary": "ClientFavorites.batch_restore", "tags": ["Client"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ClientFavorites on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ClientFavorites. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ClientFavorite to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ClientFavorite.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ClientSettings/{id}": {"get": {"description": "Returns ClientSetting with given id", "operationId": "ClientSettings.get", "summary": "ClientSettings.get", "tags": ["Client"], "parameters": [{"name": "id", "in": "path", "description": "ID of ClientSetting to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ClientSetting data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ClientSetting"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ClientSettings": {"get": {"description": "Returns all defined ClientSettings", "operationId": "ClientSettings.list", "summary": "ClientSettings.list", "tags": ["Client"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ClientSettings are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ClientSettings", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ClientSetting"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ClientStoryReads/{id}": {"get": {"description": "Returns ClientStoryRead with given id", "operationId": "ClientStoryReads.get", "summary": "ClientStoryReads.get", "tags": ["Client"], "parameters": [{"name": "id", "in": "path", "description": "ID of ClientStoryRead to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ClientStoryRead data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ClientStoryRead"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ClientStoryRead with given id", "operationId": "ClientStoryReads.delete", "summary": "ClientStoryReads.delete", "tags": ["Client"], "parameters": [{"name": "id", "in": "path", "description": "ID of ClientStoryRead to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ClientStoryRead on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ClientStoryRead", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ClientStoryRead or ClientStoryReads with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ClientStoryRead to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ClientStoryRead on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ClientStoryReads.update", "summary": "ClientStoryReads.update", "tags": ["Client"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateClientStoryReadInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ClientStoryRead", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ClientStoryRead"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ClientStoryReads": {"get": {"description": "Returns all defined ClientStoryReads", "operationId": "ClientStoryReads.list", "summary": "ClientStoryReads.list", "tags": ["Client"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ClientStoryReads are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ClientStoryReads", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ClientStoryRead"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ClientStoryRead", "operationId": "ClientStoryReads.create", "summary": "ClientStoryReads.create", "tags": ["Client"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ClientStoryRead on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ClientStoryRead", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createClientStoryReadInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ClientStoryRead", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ClientStoryRead"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ClientStoryReads/batch-delete": {"post": {"description": "Removes ClientStoryReads with given list of ids", "operationId": "ClientStoryReads.batch_delete", "summary": "ClientStoryReads.batch_delete", "tags": ["Client"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ClientStoryReads on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ClientStoryReads. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ClientStoryRead to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ClientStoryRead.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ClientStoryReads/batch-modify": {"post": {"description": "Create or update an batch of ClientStoryReads", "operationId": "ClientStoryReads.batch_create_or_update", "summary": "ClientStoryReads.batch_create_or_update", "tags": ["Client"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ClientStoryReads on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ClientStoryReads. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ClientStoryRead", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchClientStoryReadInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ClientStoryReads", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ClientStoryReads/batch-restore": {"post": {"description": "Restores ClientStoryReads with given list of ids", "operationId": "ClientStoryReads.batch_restore", "summary": "ClientStoryReads.batch_restore", "tags": ["Client"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ClientStoryReads on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ClientStoryReads. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ClientStoryRead to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ClientStoryRead.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CloudObjects/{id}": {"get": {"description": "Returns CloudObject with given id", "operationId": "CloudObjects.get", "summary": "CloudObjects.get", "tags": ["Document"], "parameters": [{"name": "id", "in": "path", "description": "ID of CloudObject to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "CloudObject data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CloudObject"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes CloudObject with given id", "operationId": "CloudObjects.delete", "summary": "CloudObjects.delete", "tags": ["Document"], "parameters": [{"name": "id", "in": "path", "description": "ID of CloudObject to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObject on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted CloudObject", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies CloudObject or CloudObjects with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of CloudObject to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObject on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "CloudObjects.update", "summary": "CloudObjects.update", "tags": ["Document"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateCloudObjectInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting CloudObject", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CloudObject"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CloudObjects": {"get": {"description": "Returns all defined CloudObjects", "operationId": "CloudObjects.list", "summary": "CloudObjects.list", "tags": ["Document"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted CloudObjects are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of CloudObjects", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/CloudObject"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new CloudObject", "operationId": "CloudObjects.create", "summary": "CloudObjects.create", "tags": ["Document"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObject on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new CloudObject", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createCloudObjectInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created CloudObject", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CloudObject"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CloudObjects/batch-delete": {"post": {"description": "Removes CloudObjects with given list of ids", "operationId": "CloudObjects.batch_delete", "summary": "CloudObjects.batch_delete", "tags": ["Document"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjects on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for CloudObjects. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity CloudObject to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted CloudObject.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CloudObjects/batch-modify": {"post": {"description": "Create or update an batch of CloudObjects", "operationId": "CloudObjects.batch_create_or_update", "summary": "CloudObjects.batch_create_or_update", "tags": ["Document"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjects on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for CloudObjects. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new CloudObject", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchCloudObjectInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated CloudObjects", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CloudObjects/batch-restore": {"post": {"description": "Restores CloudObjects with given list of ids", "operationId": "CloudObjects.batch_restore", "summary": "CloudObjects.batch_restore", "tags": ["Document"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjects on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for CloudObjects. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity CloudObject to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored CloudObject.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CloudObjectFolders/{id}": {"get": {"description": "Returns CloudObjectFolder with given id", "operationId": "CloudObjectFolders.get", "summary": "CloudObjectFolders.get", "tags": ["Document"], "parameters": [{"name": "id", "in": "path", "description": "ID of CloudObjectFolder to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "CloudObjectFolder data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CloudObjectFolder"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes CloudObjectFolder with given id", "operationId": "CloudObjectFolders.delete", "summary": "CloudObjectFolders.delete", "tags": ["Document"], "parameters": [{"name": "id", "in": "path", "description": "ID of CloudObjectFolder to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjectFolder on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted CloudObjectFolder", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies CloudObjectFolder or CloudObjectFolders with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of CloudObjectFolder to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjectFolder on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "CloudObjectFolders.update", "summary": "CloudObjectFolders.update", "tags": ["Document"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateCloudObjectFolderInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting CloudObjectFolder", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CloudObjectFolder"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CloudObjectFolders": {"get": {"description": "Returns all defined CloudObjectFolders", "operationId": "CloudObjectFolders.list", "summary": "CloudObjectFolders.list", "tags": ["Document"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted CloudObjectFolders are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of CloudObjectFolders", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/CloudObjectFolder"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new CloudObjectFolder", "operationId": "CloudObjectFolders.create", "summary": "CloudObjectFolders.create", "tags": ["Document"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjectFolder on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new CloudObjectFolder", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createCloudObjectFolderInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created CloudObjectFolder", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CloudObjectFolder"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CloudObjectFolders/batch-delete": {"post": {"description": "Removes CloudObjectFolders with given list of ids", "operationId": "CloudObjectFolders.batch_delete", "summary": "CloudObjectFolders.batch_delete", "tags": ["Document"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjectFolders on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for CloudObjectFolders. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity CloudObjectFolder to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted CloudObjectFolder.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CloudObjectFolders/batch-modify": {"post": {"description": "Create or update an batch of CloudObjectFolders", "operationId": "CloudObjectFolders.batch_create_or_update", "summary": "CloudObjectFolders.batch_create_or_update", "tags": ["Document"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjectFolders on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for CloudObjectFolders. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new CloudObjectFolder", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchCloudObjectFolderInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated CloudObjectFolders", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CloudObjectFolders/batch-restore": {"post": {"description": "Restores CloudObjectFolders with given list of ids", "operationId": "CloudObjectFolders.batch_restore", "summary": "CloudObjectFolders.batch_restore", "tags": ["Document"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjectFolders on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for CloudObjectFolders. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity CloudObjectFolder to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored CloudObjectFolder.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CloudObjectRelations/{id}": {"get": {"description": "Returns CloudObjectRelation with given id", "operationId": "CloudObjectRelations.get", "summary": "CloudObjectRelations.get", "tags": ["Document"], "parameters": [{"name": "id", "in": "path", "description": "ID of CloudObjectRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "CloudObjectRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CloudObjectRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes CloudObjectRelation with given id", "operationId": "CloudObjectRelations.delete", "summary": "CloudObjectRelations.delete", "tags": ["Document"], "parameters": [{"name": "id", "in": "path", "description": "ID of CloudObjectRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjectRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted CloudObjectRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies CloudObjectRelation or CloudObjectRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of CloudObjectRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjectRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "CloudObjectRelations.update", "summary": "CloudObjectRelations.update", "tags": ["Document"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateCloudObjectRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting CloudObjectRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CloudObjectRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CloudObjectRelations": {"get": {"description": "Returns all defined CloudObjectRelations", "operationId": "CloudObjectRelations.list", "summary": "CloudObjectRelations.list", "tags": ["Document"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted CloudObjectRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of CloudObjectRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/CloudObjectRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new CloudObjectRelation", "operationId": "CloudObjectRelations.create", "summary": "CloudObjectRelations.create", "tags": ["Document"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjectRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new CloudObjectRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createCloudObjectRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created CloudObjectRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CloudObjectRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CloudObjectRelations/batch-delete": {"post": {"description": "Removes CloudObjectRelations with given list of ids", "operationId": "CloudObjectRelations.batch_delete", "summary": "CloudObjectRelations.batch_delete", "tags": ["Document"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjectRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for CloudObjectRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity CloudObjectRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted CloudObjectRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CloudObjectRelations/batch-modify": {"post": {"description": "Create or update an batch of CloudObjectRelations", "operationId": "CloudObjectRelations.batch_create_or_update", "summary": "CloudObjectRelations.batch_create_or_update", "tags": ["Document"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjectRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for CloudObjectRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new CloudObjectRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchCloudObjectRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated CloudObjectRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CloudObjectRelations/batch-restore": {"post": {"description": "Restores CloudObjectRelations with given list of ids", "operationId": "CloudObjectRelations.batch_restore", "summary": "CloudObjectRelations.batch_restore", "tags": ["Document"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjectRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for CloudObjectRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity CloudObjectRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored CloudObjectRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CloudObjectStepRelations/{id}": {"get": {"description": "Returns CloudObjectStepRelation with given id", "operationId": "CloudObjectStepRelations.get", "summary": "CloudObjectStepRelations.get", "tags": ["Document"], "parameters": [{"name": "id", "in": "path", "description": "ID of CloudObjectStepRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "CloudObjectStepRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CloudObjectStepRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes CloudObjectStepRelation with given id", "operationId": "CloudObjectStepRelations.delete", "summary": "CloudObjectStepRelations.delete", "tags": ["Document"], "parameters": [{"name": "id", "in": "path", "description": "ID of CloudObjectStepRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjectStepRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted CloudObjectStepRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies CloudObjectStepRelation or CloudObjectStepRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of CloudObjectStepRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjectStepRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "CloudObjectStepRelations.update", "summary": "CloudObjectStepRelations.update", "tags": ["Document"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateCloudObjectStepRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting CloudObjectStepRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CloudObjectStepRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CloudObjectStepRelations": {"get": {"description": "Returns all defined CloudObjectStepRelations", "operationId": "CloudObjectStepRelations.list", "summary": "CloudObjectStepRelations.list", "tags": ["Document"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted CloudObjectStepRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of CloudObjectStepRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/CloudObjectStepRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new CloudObjectStepRelation", "operationId": "CloudObjectStepRelations.create", "summary": "CloudObjectStepRelations.create", "tags": ["Document"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjectStepRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new CloudObjectStepRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createCloudObjectStepRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created CloudObjectStepRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CloudObjectStepRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CloudObjectStepRelations/batch-delete": {"post": {"description": "Removes CloudObjectStepRelations with given list of ids", "operationId": "CloudObjectStepRelations.batch_delete", "summary": "CloudObjectStepRelations.batch_delete", "tags": ["Document"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjectStepRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for CloudObjectStepRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity CloudObjectStepRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted CloudObjectStepRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CloudObjectStepRelations/batch-modify": {"post": {"description": "Create or update an batch of CloudObjectStepRelations", "operationId": "CloudObjectStepRelations.batch_create_or_update", "summary": "CloudObjectStepRelations.batch_create_or_update", "tags": ["Document"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjectStepRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for CloudObjectStepRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new CloudObjectStepRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchCloudObjectStepRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated CloudObjectStepRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CloudObjectStepRelations/batch-restore": {"post": {"description": "Restores CloudObjectStepRelations with given list of ids", "operationId": "CloudObjectStepRelations.batch_restore", "summary": "CloudObjectStepRelations.batch_restore", "tags": ["Document"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjectStepRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for CloudObjectStepRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity CloudObjectStepRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored CloudObjectStepRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CloudObjectTemplates/{id}": {"get": {"description": "Returns CloudObjectTemplate with given id", "operationId": "CloudObjectTemplates.get", "summary": "CloudObjectTemplates.get", "tags": ["Document"], "parameters": [{"name": "id", "in": "path", "description": "ID of CloudObjectTemplate to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "CloudObjectTemplate data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CloudObjectTemplate"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes CloudObjectTemplate with given id", "operationId": "CloudObjectTemplates.delete", "summary": "CloudObjectTemplates.delete", "tags": ["Document"], "parameters": [{"name": "id", "in": "path", "description": "ID of CloudObjectTemplate to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjectTemplate on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted CloudObjectTemplate", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies CloudObjectTemplate or CloudObjectTemplates with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of CloudObjectTemplate to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjectTemplate on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "CloudObjectTemplates.update", "summary": "CloudObjectTemplates.update", "tags": ["Document"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateCloudObjectTemplateInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting CloudObjectTemplate", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CloudObjectTemplate"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CloudObjectTemplates": {"get": {"description": "Returns all defined CloudObjectTemplates", "operationId": "CloudObjectTemplates.list", "summary": "CloudObjectTemplates.list", "tags": ["Document"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted CloudObjectTemplates are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of CloudObjectTemplates", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/CloudObjectTemplate"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new CloudObjectTemplate", "operationId": "CloudObjectTemplates.create", "summary": "CloudObjectTemplates.create", "tags": ["Document"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjectTemplate on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new CloudObjectTemplate", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createCloudObjectTemplateInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created CloudObjectTemplate", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CloudObjectTemplate"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CloudObjectTemplates/batch-delete": {"post": {"description": "Removes CloudObjectTemplates with given list of ids", "operationId": "CloudObjectTemplates.batch_delete", "summary": "CloudObjectTemplates.batch_delete", "tags": ["Document"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjectTemplates on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for CloudObjectTemplates. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity CloudObjectTemplate to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted CloudObjectTemplate.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CloudObjectTemplates/batch-modify": {"post": {"description": "Create or update an batch of CloudObjectTemplates", "operationId": "CloudObjectTemplates.batch_create_or_update", "summary": "CloudObjectTemplates.batch_create_or_update", "tags": ["Document"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjectTemplates on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for CloudObjectTemplates. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new CloudObjectTemplate", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchCloudObjectTemplateInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated CloudObjectTemplates", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CloudObjectTemplates/batch-restore": {"post": {"description": "Restores CloudObjectTemplates with given list of ids", "operationId": "CloudObjectTemplates.batch_restore", "summary": "CloudObjectTemplates.batch_restore", "tags": ["Document"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CloudObjectTemplates on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for CloudObjectTemplates. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity CloudObjectTemplate to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored CloudObjectTemplate.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CompanyEmails/{id}": {"get": {"description": "Returns CompanyEmail with given id", "operationId": "CompanyEmails.get", "summary": "CompanyEmails.get", "tags": ["Company Email"], "parameters": [{"name": "id", "in": "path", "description": "ID of CompanyEmail to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "CompanyEmail data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CompanyEmail"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CompanyEmails": {"get": {"description": "Returns all defined CompanyEmails", "operationId": "CompanyEmails.list", "summary": "CompanyEmails.list", "tags": ["Company Email"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted CompanyEmails are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of CompanyEmails", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/CompanyEmail"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Contacts/{id}": {"get": {"description": "Returns Contact with given id", "operationId": "Contacts.get", "summary": "Contacts.get", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of Contact to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Contact data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Contact"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Contact with given id", "operationId": "Contacts.delete", "summary": "Contacts.delete", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of Contact to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Contact on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Contact", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Contact or Contacts with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Contact to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Contact on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Contacts.update", "summary": "Contacts.update", "tags": ["Contact"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateContactInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Contact", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Contact"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Contacts": {"get": {"description": "Returns all defined Contacts", "operationId": "Contacts.list", "summary": "Contacts.list", "tags": ["Contact"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Contacts are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Contacts", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Contact"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Contact", "operationId": "Contacts.create", "summary": "Contacts.create", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Contact on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Contact", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createContactInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Contact", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Contact"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Contacts/merge": {"post": {"description": "Merger multiple Contacts into master record.", "operationId": "Contacts.merge", "summary": "Contacts.merge", "tags": ["Contact"], "parameters": [], "requestBody": {"description": "Entity .", "required": true, "content": {"application/json": {"schema": {"type": "object", "properties": {"master": {"$ref": "#/components/schemas/batchContactInput"}, "secondary_ids": {"type": "array", "items": {"type": "string", "description": "An id of secondary Contact.", "format": "uuid"}}}}}}}, "responses": {"200": {"description": "Merged entity", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Contact"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Contacts/batch-delete": {"post": {"description": "Removes Contacts with given list of ids", "operationId": "Contacts.batch_delete", "summary": "Contacts.batch_delete", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Contacts on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Contacts. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Contact to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Contact.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Contacts/batch-modify": {"post": {"description": "Create or update an batch of Contacts", "operationId": "Contacts.batch_create_or_update", "summary": "Contacts.batch_create_or_update", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Contacts on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Contacts. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Contact", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchContactInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Contacts", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Contacts/batch-restore": {"post": {"description": "Restores Contacts with given list of ids", "operationId": "Contacts.batch_restore", "summary": "Contacts.batch_restore", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Contacts on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Contacts. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Contact to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Contact.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactAccountAccountRoleRelations/{id}": {"get": {"description": "Returns ContactAccountAccountRoleRelation with given id", "operationId": "ContactAccountAccountRoleRelations.get", "summary": "ContactAccountAccountRoleRelations.get", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of ContactAccountAccountRoleRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ContactAccountAccountRoleRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactAccountAccountRoleRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ContactAccountAccountRoleRelation with given id", "operationId": "ContactAccountAccountRoleRelations.delete", "summary": "ContactAccountAccountRoleRelations.delete", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of ContactAccountAccountRoleRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ContactAccountAccountRoleRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ContactAccountAccountRoleRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ContactAccountAccountRoleRelation or ContactAccountAccountRoleRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ContactAccountAccountRoleRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ContactAccountAccountRoleRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ContactAccountAccountRoleRelations.update", "summary": "ContactAccountAccountRoleRelations.update", "tags": ["Contact"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateContactAccountAccountRoleRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ContactAccountAccountRoleRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactAccountAccountRoleRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactAccountAccountRoleRelations": {"get": {"description": "Returns all defined ContactAccountAccountRoleRelations", "operationId": "ContactAccountAccountRoleRelations.list", "summary": "ContactAccountAccountRoleRelations.list", "tags": ["Contact"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ContactAccountAccountRoleRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ContactAccountAccountRoleRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ContactAccountAccountRoleRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ContactAccountAccountRoleRelation", "operationId": "ContactAccountAccountRoleRelations.create", "summary": "ContactAccountAccountRoleRelations.create", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactAccountAccountRoleRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ContactAccountAccountRoleRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createContactAccountAccountRoleRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ContactAccountAccountRoleRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactAccountAccountRoleRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactAccountAccountRoleRelations/batch-delete": {"post": {"description": "Removes ContactAccountAccountRoleRelations with given list of ids", "operationId": "ContactAccountAccountRoleRelations.batch_delete", "summary": "ContactAccountAccountRoleRelations.batch_delete", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactAccountAccountRoleRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactAccountAccountRoleRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ContactAccountAccountRoleRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ContactAccountAccountRoleRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactAccountAccountRoleRelations/batch-modify": {"post": {"description": "Create or update an batch of ContactAccountAccountRoleRelations", "operationId": "ContactAccountAccountRoleRelations.batch_create_or_update", "summary": "ContactAccountAccountRoleRelations.batch_create_or_update", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactAccountAccountRoleRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactAccountAccountRoleRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ContactAccountAccountRoleRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchContactAccountAccountRoleRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ContactAccountAccountRoleRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactAccountAccountRoleRelations/batch-restore": {"post": {"description": "Restores ContactAccountAccountRoleRelations with given list of ids", "operationId": "ContactAccountAccountRoleRelations.batch_restore", "summary": "ContactAccountAccountRoleRelations.batch_restore", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactAccountAccountRoleRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactAccountAccountRoleRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ContactAccountAccountRoleRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ContactAccountAccountRoleRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactAccountRelations/{id}": {"get": {"description": "Returns ContactAccountRelation with given id", "operationId": "ContactAccountRelations.get", "summary": "ContactAccountRelations.get", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of ContactAccountRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ContactAccountRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactAccountRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ContactAccountRelation with given id", "operationId": "ContactAccountRelations.delete", "summary": "ContactAccountRelations.delete", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of ContactAccountRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ContactAccountRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ContactAccountRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ContactAccountRelation or ContactAccountRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ContactAccountRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ContactAccountRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ContactAccountRelations.update", "summary": "ContactAccountRelations.update", "tags": ["Contact"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateContactAccountRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ContactAccountRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactAccountRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactAccountRelations": {"get": {"description": "Returns all defined ContactAccountRelations", "operationId": "ContactAccountRelations.list", "summary": "ContactAccountRelations.list", "tags": ["Contact"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ContactAccountRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ContactAccountRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ContactAccountRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ContactAccountRelation", "operationId": "ContactAccountRelations.create", "summary": "ContactAccountRelations.create", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactAccountRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ContactAccountRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createContactAccountRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ContactAccountRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactAccountRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactAccountRelations/batch-delete": {"post": {"description": "Removes ContactAccountRelations with given list of ids", "operationId": "ContactAccountRelations.batch_delete", "summary": "ContactAccountRelations.batch_delete", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactAccountRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactAccountRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ContactAccountRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ContactAccountRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactAccountRelations/batch-modify": {"post": {"description": "Create or update an batch of ContactAccountRelations", "operationId": "ContactAccountRelations.batch_create_or_update", "summary": "ContactAccountRelations.batch_create_or_update", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactAccountRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactAccountRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ContactAccountRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchContactAccountRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ContactAccountRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactAccountRelations/batch-restore": {"post": {"description": "Restores ContactAccountRelations with given list of ids", "operationId": "ContactAccountRelations.batch_restore", "summary": "ContactAccountRelations.batch_restore", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactAccountRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactAccountRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ContactAccountRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ContactAccountRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactDataExRelations/{id}": {"get": {"description": "Returns ContactDataExRelation with given id", "operationId": "ContactDataExRelations.get", "summary": "ContactDataExRelations.get", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of ContactDataExRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ContactDataExRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactDataExRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactDataExRelations": {"get": {"description": "Returns all defined ContactDataExRelations", "operationId": "ContactDataExRelations.list", "summary": "ContactDataExRelations.list", "tags": ["Contact"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ContactDataExRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ContactDataExRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ContactDataExRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactKPIs/{id}": {"get": {"description": "Returns ContactKPI with given id", "operationId": "ContactKPIs.get", "summary": "ContactKPIs.get", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of ContactKPI to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ContactKPI data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactKPI"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ContactKPI with given id", "operationId": "ContactKPIs.delete", "summary": "ContactKPIs.delete", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of ContactKPI to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ContactKPI on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ContactKPI", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ContactKPI or ContactKPIs with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ContactKPI to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ContactKPI on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ContactKPIs.update", "summary": "ContactKPIs.update", "tags": ["Contact"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateContactKPIInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ContactKPI", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactKPI"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactKPIs": {"get": {"description": "Returns all defined ContactKPIs", "operationId": "ContactKPIs.list", "summary": "ContactKPIs.list", "tags": ["Contact"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ContactKPIs are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ContactKPIs", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ContactKPI"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ContactKPI", "operationId": "ContactKPIs.create", "summary": "ContactKPIs.create", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactKPI on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ContactKPI", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createContactKPIInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ContactKPI", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactKPI"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactKPIs/batch-delete": {"post": {"description": "Removes ContactKPIs with given list of ids", "operationId": "ContactKPIs.batch_delete", "summary": "ContactKPIs.batch_delete", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactKPIs on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactKPIs. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ContactKPI to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ContactKPI.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactKPIs/batch-modify": {"post": {"description": "Create or update an batch of ContactKPIs", "operationId": "ContactKPIs.batch_create_or_update", "summary": "ContactKPIs.batch_create_or_update", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactKPIs on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactKPIs. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ContactKPI", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchContactKPIInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ContactKPIs", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactKPIs/batch-restore": {"post": {"description": "Restores ContactKPIs with given list of ids", "operationId": "ContactKPIs.batch_restore", "summary": "ContactKPIs.batch_restore", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactKPIs on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactKPIs. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ContactKPI to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ContactKPI.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactRelations/{id}": {"get": {"description": "Returns ContactRelation with given id", "operationId": "ContactRelations.get", "summary": "ContactRelations.get", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of ContactRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ContactRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ContactRelation with given id", "operationId": "ContactRelations.delete", "summary": "ContactRelations.delete", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of ContactRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ContactRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ContactRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ContactRelation or ContactRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ContactRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ContactRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ContactRelations.update", "summary": "ContactRelations.update", "tags": ["Contact"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateContactRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ContactRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactRelations": {"get": {"description": "Returns all defined ContactRelations", "operationId": "ContactRelations.list", "summary": "ContactRelations.list", "tags": ["Contact"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ContactRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ContactRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ContactRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ContactRelation", "operationId": "ContactRelations.create", "summary": "ContactRelations.create", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ContactRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createContactRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ContactRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactRelations/batch-delete": {"post": {"description": "Removes ContactRelations with given list of ids", "operationId": "ContactRelations.batch_delete", "summary": "ContactRelations.batch_delete", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ContactRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ContactRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactRelations/batch-modify": {"post": {"description": "Create or update an batch of ContactRelations", "operationId": "ContactRelations.batch_create_or_update", "summary": "ContactRelations.batch_create_or_update", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ContactRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchContactRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ContactRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactRelations/batch-restore": {"post": {"description": "Restores ContactRelations with given list of ids", "operationId": "ContactRelations.batch_restore", "summary": "ContactRelations.batch_restore", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ContactRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ContactRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactRelationLabels/{id}": {"get": {"description": "Returns ContactRelationLabel with given id", "operationId": "ContactRelationLabels.get", "summary": "ContactRelationLabels.get", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of ContactRelationLabel to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ContactRelationLabel data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactRelationLabel"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ContactRelationLabel with given id", "operationId": "ContactRelationLabels.delete", "summary": "ContactRelationLabels.delete", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of ContactRelationLabel to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ContactRelationLabel on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ContactRelationLabel", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ContactRelationLabel or ContactRelationLabels with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ContactRelationLabel to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ContactRelationLabel on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ContactRelationLabels.update", "summary": "ContactRelationLabels.update", "tags": ["Contact"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateContactRelationLabelInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ContactRelationLabel", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactRelationLabel"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactRelationLabels": {"get": {"description": "Returns all defined ContactRelationLabels", "operationId": "ContactRelationLabels.list", "summary": "ContactRelationLabels.list", "tags": ["Contact"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ContactRelationLabels are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ContactRelationLabels", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ContactRelationLabel"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ContactRelationLabel", "operationId": "ContactRelationLabels.create", "summary": "ContactRelationLabels.create", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactRelationLabel on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ContactRelationLabel", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createContactRelationLabelInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ContactRelationLabel", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactRelationLabel"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactRelationLabels/batch-delete": {"post": {"description": "Removes ContactRelationLabels with given list of ids", "operationId": "ContactRelationLabels.batch_delete", "summary": "ContactRelationLabels.batch_delete", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactRelationLabels on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactRelationLabels. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ContactRelationLabel to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ContactRelationLabel.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactRelationLabels/batch-modify": {"post": {"description": "Create or update an batch of ContactRelationLabels", "operationId": "ContactRelationLabels.batch_create_or_update", "summary": "ContactRelationLabels.batch_create_or_update", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactRelationLabels on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactRelationLabels. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ContactRelationLabel", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchContactRelationLabelInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ContactRelationLabels", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactRelationLabels/batch-restore": {"post": {"description": "Restores ContactRelationLabels with given list of ids", "operationId": "ContactRelationLabels.batch_restore", "summary": "ContactRelationLabels.batch_restore", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactRelationLabels on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactRelationLabels. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ContactRelationLabel to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ContactRelationLabel.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactRelationTypes/{id}": {"get": {"description": "Returns ContactRelationType with given id", "operationId": "ContactRelationTypes.get", "summary": "ContactRelationTypes.get", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of ContactRelationType to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ContactRelationType data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactRelationType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ContactRelationType with given id", "operationId": "ContactRelationTypes.delete", "summary": "ContactRelationTypes.delete", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of ContactRelationType to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ContactRelationType on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ContactRelationType", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ContactRelationType or ContactRelationTypes with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ContactRelationType to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ContactRelationType on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ContactRelationTypes.update", "summary": "ContactRelationTypes.update", "tags": ["Contact"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateContactRelationTypeInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ContactRelationType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactRelationType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactRelationTypes": {"get": {"description": "Returns all defined ContactRelationTypes", "operationId": "ContactRelationTypes.list", "summary": "ContactRelationTypes.list", "tags": ["Contact"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ContactRelationTypes are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ContactRelationTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ContactRelationType"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ContactRelationType", "operationId": "ContactRelationTypes.create", "summary": "ContactRelationTypes.create", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactRelationType on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ContactRelationType", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createContactRelationTypeInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ContactRelationType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactRelationType"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactRelationTypes/batch-delete": {"post": {"description": "Removes ContactRelationTypes with given list of ids", "operationId": "ContactRelationTypes.batch_delete", "summary": "ContactRelationTypes.batch_delete", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactRelationTypes on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactRelationTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ContactRelationType to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ContactRelationType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactRelationTypes/batch-modify": {"post": {"description": "Create or update an batch of ContactRelationTypes", "operationId": "ContactRelationTypes.batch_create_or_update", "summary": "ContactRelationTypes.batch_create_or_update", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactRelationTypes on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactRelationTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ContactRelationType", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchContactRelationTypeInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ContactRelationTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactRelationTypes/batch-restore": {"post": {"description": "Restores ContactRelationTypes with given list of ids", "operationId": "ContactRelationTypes.batch_restore", "summary": "ContactRelationTypes.batch_restore", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactRelationTypes on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactRelationTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ContactRelationType to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ContactRelationType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactSharingClientRelations/{id}": {"get": {"description": "Returns ContactSharingClientRelation with given id", "operationId": "ContactSharingClientRelations.get", "summary": "ContactSharingClientRelations.get", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of ContactSharingClientRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ContactSharingClientRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactSharingClientRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ContactSharingClientRelation with given id", "operationId": "ContactSharingClientRelations.delete", "summary": "ContactSharingClientRelations.delete", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of ContactSharingClientRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ContactSharingClientRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ContactSharingClientRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ContactSharingClientRelation or ContactSharingClientRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ContactSharingClientRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ContactSharingClientRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ContactSharingClientRelations.update", "summary": "ContactSharingClientRelations.update", "tags": ["Contact"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateContactSharingClientRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ContactSharingClientRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactSharingClientRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactSharingClientRelations": {"get": {"description": "Returns all defined ContactSharingClientRelations", "operationId": "ContactSharingClientRelations.list", "summary": "ContactSharingClientRelations.list", "tags": ["Contact"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ContactSharingClientRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ContactSharingClientRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ContactSharingClientRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ContactSharingClientRelation", "operationId": "ContactSharingClientRelations.create", "summary": "ContactSharingClientRelations.create", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactSharingClientRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ContactSharingClientRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createContactSharingClientRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ContactSharingClientRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactSharingClientRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactSharingClientRelations/batch-delete": {"post": {"description": "Removes ContactSharingClientRelations with given list of ids", "operationId": "ContactSharingClientRelations.batch_delete", "summary": "ContactSharingClientRelations.batch_delete", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactSharingClientRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ContactSharingClientRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ContactSharingClientRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactSharingClientRelations/batch-modify": {"post": {"description": "Create or update an batch of ContactSharingClientRelations", "operationId": "ContactSharingClientRelations.batch_create_or_update", "summary": "ContactSharingClientRelations.batch_create_or_update", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactSharingClientRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ContactSharingClientRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchContactSharingClientRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ContactSharingClientRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactSharingClientRelations/batch-restore": {"post": {"description": "Restores ContactSharingClientRelations with given list of ids", "operationId": "ContactSharingClientRelations.batch_restore", "summary": "ContactSharingClientRelations.batch_restore", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactSharingClientRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ContactSharingClientRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ContactSharingClientRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactSharingSalesUnitRelations/{id}": {"get": {"description": "Returns ContactSharingSalesUnitRelation with given id", "operationId": "ContactSharingSalesUnitRelations.get", "summary": "ContactSharingSalesUnitRelations.get", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of ContactSharingSalesUnitRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ContactSharingSalesUnitRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactSharingSalesUnitRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ContactSharingSalesUnitRelation with given id", "operationId": "ContactSharingSalesUnitRelations.delete", "summary": "ContactSharingSalesUnitRelations.delete", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of ContactSharingSalesUnitRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ContactSharingSalesUnitRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ContactSharingSalesUnitRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ContactSharingSalesUnitRelation or ContactSharingSalesUnitRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ContactSharingSalesUnitRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ContactSharingSalesUnitRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ContactSharingSalesUnitRelations.update", "summary": "ContactSharingSalesUnitRelations.update", "tags": ["Contact"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateContactSharingSalesUnitRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ContactSharingSalesUnitRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactSharingSalesUnitRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactSharingSalesUnitRelations": {"get": {"description": "Returns all defined ContactSharingSalesUnitRelations", "operationId": "ContactSharingSalesUnitRelations.list", "summary": "ContactSharingSalesUnitRelations.list", "tags": ["Contact"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ContactSharingSalesUnitRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ContactSharingSalesUnitRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ContactSharingSalesUnitRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ContactSharingSalesUnitRelation", "operationId": "ContactSharingSalesUnitRelations.create", "summary": "ContactSharingSalesUnitRelations.create", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactSharingSalesUnitRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ContactSharingSalesUnitRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createContactSharingSalesUnitRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ContactSharingSalesUnitRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactSharingSalesUnitRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactSharingSalesUnitRelations/batch-delete": {"post": {"description": "Removes ContactSharingSalesUnitRelations with given list of ids", "operationId": "ContactSharingSalesUnitRelations.batch_delete", "summary": "ContactSharingSalesUnitRelations.batch_delete", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactSharingSalesUnitRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ContactSharingSalesUnitRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ContactSharingSalesUnitRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactSharingSalesUnitRelations/batch-modify": {"post": {"description": "Create or update an batch of ContactSharingSalesUnitRelations", "operationId": "ContactSharingSalesUnitRelations.batch_create_or_update", "summary": "ContactSharingSalesUnitRelations.batch_create_or_update", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactSharingSalesUnitRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ContactSharingSalesUnitRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchContactSharingSalesUnitRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ContactSharingSalesUnitRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactSharingSalesUnitRelations/batch-restore": {"post": {"description": "Restores ContactSharingSalesUnitRelations with given list of ids", "operationId": "ContactSharingSalesUnitRelations.batch_restore", "summary": "ContactSharingSalesUnitRelations.batch_restore", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactSharingSalesUnitRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ContactSharingSalesUnitRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ContactSharingSalesUnitRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactSocialRelations/{id}": {"get": {"description": "Returns ContactSocialRelation with given id", "operationId": "ContactSocialRelations.get", "summary": "ContactSocialRelations.get", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of ContactSocialRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ContactSocialRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactSocialRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ContactSocialRelation with given id", "operationId": "ContactSocialRelations.delete", "summary": "ContactSocialRelations.delete", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of ContactSocialRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ContactSocialRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ContactSocialRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ContactSocialRelation or ContactSocialRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ContactSocialRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ContactSocialRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ContactSocialRelations.update", "summary": "ContactSocialRelations.update", "tags": ["Contact"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateContactSocialRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ContactSocialRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactSocialRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactSocialRelations": {"get": {"description": "Returns all defined ContactSocialRelations", "operationId": "ContactSocialRelations.list", "summary": "ContactSocialRelations.list", "tags": ["Contact"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ContactSocialRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ContactSocialRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ContactSocialRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ContactSocialRelation", "operationId": "ContactSocialRelations.create", "summary": "ContactSocialRelations.create", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactSocialRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ContactSocialRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createContactSocialRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ContactSocialRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactSocialRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactSocialRelations/batch-delete": {"post": {"description": "Removes ContactSocialRelations with given list of ids", "operationId": "ContactSocialRelations.batch_delete", "summary": "ContactSocialRelations.batch_delete", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactSocialRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactSocialRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ContactSocialRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ContactSocialRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactSocialRelations/batch-modify": {"post": {"description": "Create or update an batch of ContactSocialRelations", "operationId": "ContactSocialRelations.batch_create_or_update", "summary": "ContactSocialRelations.batch_create_or_update", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactSocialRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactSocialRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ContactSocialRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchContactSocialRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ContactSocialRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactSocialRelations/batch-restore": {"post": {"description": "Restores ContactSocialRelations with given list of ids", "operationId": "ContactSocialRelations.batch_restore", "summary": "ContactSocialRelations.batch_restore", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactSocialRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactSocialRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ContactSocialRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ContactSocialRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactTypes/{id}": {"get": {"description": "Returns ContactType with given id", "operationId": "ContactTypes.get", "summary": "ContactTypes.get", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of ContactType to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ContactType data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ContactType with given id", "operationId": "ContactTypes.delete", "summary": "ContactTypes.delete", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of ContactType to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ContactType on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ContactType", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ContactType or ContactTypes with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ContactType to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ContactType on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ContactTypes.update", "summary": "ContactTypes.update", "tags": ["Contact"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateContactTypeInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ContactType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactTypes": {"get": {"description": "Returns all defined ContactTypes", "operationId": "ContactTypes.list", "summary": "ContactTypes.list", "tags": ["Contact"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ContactTypes are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ContactTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ContactType"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ContactType", "operationId": "ContactTypes.create", "summary": "ContactTypes.create", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactType on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ContactType", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createContactTypeInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ContactType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ContactType"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactTypes/batch-delete": {"post": {"description": "Removes ContactTypes with given list of ids", "operationId": "ContactTypes.batch_delete", "summary": "ContactTypes.batch_delete", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactTypes on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ContactType to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ContactType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactTypes/batch-modify": {"post": {"description": "Create or update an batch of ContactTypes", "operationId": "ContactTypes.batch_create_or_update", "summary": "ContactTypes.batch_create_or_update", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactTypes on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ContactType", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchContactTypeInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ContactTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ContactTypes/batch-restore": {"post": {"description": "Restores ContactTypes with given list of ids", "operationId": "ContactTypes.batch_restore", "summary": "ContactTypes.batch_restore", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ContactTypes on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ContactTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ContactType to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ContactType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CountryCrms/{id}": {"get": {"description": "Returns CountryCrm with given id", "operationId": "CountryCrms.get", "summary": "CountryCrms.get", "tags": ["Country"], "parameters": [{"name": "id", "in": "path", "description": "ID of CountryCrm to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "CountryCrm data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CountryCrm"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes CountryCrm with given id", "operationId": "CountryCrms.delete", "summary": "CountryCrms.delete", "tags": ["Country"], "parameters": [{"name": "id", "in": "path", "description": "ID of CountryCrm to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of CountryCrm on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted CountryCrm", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies CountryCrm or CountryCrms with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of CountryCrm to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of CountryCrm on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "CountryCrms.update", "summary": "CountryCrms.update", "tags": ["Country"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateCountryCrmInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting CountryCrm", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CountryCrm"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CountryCrms": {"get": {"description": "Returns all defined CountryCrms", "operationId": "CountryCrms.list", "summary": "CountryCrms.list", "tags": ["Country"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted CountryCrms are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of CountryCrms", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/CountryCrm"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new CountryCrm", "operationId": "CountryCrms.create", "summary": "CountryCrms.create", "tags": ["Country"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CountryCrm on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new CountryCrm", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createCountryCrmInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created CountryCrm", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CountryCrm"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CountryCrms/batch-delete": {"post": {"description": "Removes CountryCrms with given list of ids", "operationId": "CountryCrms.batch_delete", "summary": "CountryCrms.batch_delete", "tags": ["Country"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CountryCrms on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for CountryCrms. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity CountryCrm to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted CountryCrm.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CountryCrms/batch-modify": {"post": {"description": "Create or update an batch of CountryCrms", "operationId": "CountryCrms.batch_create_or_update", "summary": "CountryCrms.batch_create_or_update", "tags": ["Country"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CountryCrms on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for CountryCrms. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new CountryCrm", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchCountryCrmInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated CountryCrms", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CountryCrms/batch-restore": {"post": {"description": "Restores CountryCrms with given list of ids", "operationId": "CountryCrms.batch_restore", "summary": "CountryCrms.batch_restore", "tags": ["Country"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CountryCrms on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for CountryCrms. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity CountryCrm to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored CountryCrm.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Currencies/{id}": {"get": {"description": "Returns Currency with given id", "operationId": "Currencies.get", "summary": "Currencies.get", "tags": ["Currency"], "parameters": [{"name": "id", "in": "path", "description": "ID of Currency to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Currency data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Currency"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Currency with given id", "operationId": "Currencies.delete", "summary": "Currencies.delete", "tags": ["Currency"], "parameters": [{"name": "id", "in": "path", "description": "ID of Currency to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Currency on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Currency", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Currency or Currencies with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Currency to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Currency on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Currencies.update", "summary": "Currencies.update", "tags": ["Currency"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateCurrencyInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Currency", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Currency"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Currencies": {"get": {"description": "Returns all defined Currencies", "operationId": "Currencies.list", "summary": "Currencies.list", "tags": ["Currency"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Currencies are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Currencies", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Currency"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Currency", "operationId": "Currencies.create", "summary": "Currencies.create", "tags": ["Currency"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Currency on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Currency", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createCurrencyInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Currency", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Currency"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Currencies/batch-delete": {"post": {"description": "Removes Currencies with given list of ids", "operationId": "Currencies.batch_delete", "summary": "Currencies.batch_delete", "tags": ["Currency"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Currencies on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Currencies. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Currency to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Currency.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Currencies/batch-modify": {"post": {"description": "Create or update an batch of Currencies", "operationId": "Currencies.batch_create_or_update", "summary": "Currencies.batch_create_or_update", "tags": ["Currency"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Currencies on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Currencies. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Currency", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchCurrencyInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Currencies", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Currencies/batch-restore": {"post": {"description": "Restores Currencies with given list of ids", "operationId": "Currencies.batch_restore", "summary": "Currencies.batch_restore", "tags": ["Currency"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Currencies on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Currencies. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Currency to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Currency.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CurrencyExchangeRates/{id}": {"get": {"description": "Returns CurrencyExchangeRate with given id", "operationId": "CurrencyExchangeRates.get", "summary": "CurrencyExchangeRates.get", "tags": ["Currency"], "parameters": [{"name": "id", "in": "path", "description": "ID of CurrencyExchangeRate to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "CurrencyExchangeRate data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CurrencyExchangeRate"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes CurrencyExchangeRate with given id", "operationId": "CurrencyExchangeRates.delete", "summary": "CurrencyExchangeRates.delete", "tags": ["Currency"], "parameters": [{"name": "id", "in": "path", "description": "ID of CurrencyExchangeRate to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of CurrencyExchangeRate on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted CurrencyExchangeRate", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies CurrencyExchangeRate or CurrencyExchangeRates with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of CurrencyExchangeRate to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of CurrencyExchangeRate on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "CurrencyExchangeRates.update", "summary": "CurrencyExchangeRates.update", "tags": ["Currency"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateCurrencyExchangeRateInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting CurrencyExchangeRate", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CurrencyExchangeRate"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CurrencyExchangeRates": {"get": {"description": "Returns all defined CurrencyExchangeRates", "operationId": "CurrencyExchangeRates.list", "summary": "CurrencyExchangeRates.list", "tags": ["Currency"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted CurrencyExchangeRates are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of CurrencyExchangeRates", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/CurrencyExchangeRate"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new CurrencyExchangeRate", "operationId": "CurrencyExchangeRates.create", "summary": "CurrencyExchangeRates.create", "tags": ["Currency"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CurrencyExchangeRate on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new CurrencyExchangeRate", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createCurrencyExchangeRateInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created CurrencyExchangeRate", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CurrencyExchangeRate"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CurrencyExchangeRates/batch-delete": {"post": {"description": "Removes CurrencyExchangeRates with given list of ids", "operationId": "CurrencyExchangeRates.batch_delete", "summary": "CurrencyExchangeRates.batch_delete", "tags": ["Currency"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CurrencyExchangeRates on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for CurrencyExchangeRates. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity CurrencyExchangeRate to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted CurrencyExchangeRate.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CurrencyExchangeRates/batch-modify": {"post": {"description": "Create or update an batch of CurrencyExchangeRates", "operationId": "CurrencyExchangeRates.batch_create_or_update", "summary": "CurrencyExchangeRates.batch_create_or_update", "tags": ["Currency"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CurrencyExchangeRates on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for CurrencyExchangeRates. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new CurrencyExchangeRate", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchCurrencyExchangeRateInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated CurrencyExchangeRates", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CurrencyExchangeRates/batch-restore": {"post": {"description": "Restores CurrencyExchangeRates with given list of ids", "operationId": "CurrencyExchangeRates.batch_restore", "summary": "CurrencyExchangeRates.batch_restore", "tags": ["Currency"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CurrencyExchangeRates on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for CurrencyExchangeRates. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity CurrencyExchangeRate to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored CurrencyExchangeRate.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CurrencyExchangeRatesLists/{id}": {"get": {"description": "Returns CurrencyExchangeRatesList with given id", "operationId": "CurrencyExchangeRatesLists.get", "summary": "CurrencyExchangeRatesLists.get", "tags": ["Currency"], "parameters": [{"name": "id", "in": "path", "description": "ID of CurrencyExchangeRatesList to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "CurrencyExchangeRatesList data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CurrencyExchangeRatesList"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes CurrencyExchangeRatesList with given id", "operationId": "CurrencyExchangeRatesLists.delete", "summary": "CurrencyExchangeRatesLists.delete", "tags": ["Currency"], "parameters": [{"name": "id", "in": "path", "description": "ID of CurrencyExchangeRatesList to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of CurrencyExchangeRatesList on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted CurrencyExchangeRatesList", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies CurrencyExchangeRatesList or CurrencyExchangeRatesLists with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of CurrencyExchangeRatesList to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of CurrencyExchangeRatesList on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "CurrencyExchangeRatesLists.update", "summary": "CurrencyExchangeRatesLists.update", "tags": ["Currency"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateCurrencyExchangeRatesListInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting CurrencyExchangeRatesList", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CurrencyExchangeRatesList"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CurrencyExchangeRatesLists": {"get": {"description": "Returns all defined CurrencyExchangeRatesLists", "operationId": "CurrencyExchangeRatesLists.list", "summary": "CurrencyExchangeRatesLists.list", "tags": ["Currency"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted CurrencyExchangeRatesLists are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of CurrencyExchangeRatesLists", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/CurrencyExchangeRatesList"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new CurrencyExchangeRatesList", "operationId": "CurrencyExchangeRatesLists.create", "summary": "CurrencyExchangeRatesLists.create", "tags": ["Currency"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CurrencyExchangeRatesList on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new CurrencyExchangeRatesList", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createCurrencyExchangeRatesListInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created CurrencyExchangeRatesList", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CurrencyExchangeRatesList"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CurrencyExchangeRatesLists/batch-delete": {"post": {"description": "Removes CurrencyExchangeRatesLists with given list of ids", "operationId": "CurrencyExchangeRatesLists.batch_delete", "summary": "CurrencyExchangeRatesLists.batch_delete", "tags": ["Currency"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CurrencyExchangeRatesLists on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for CurrencyExchangeRatesLists. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity CurrencyExchangeRatesList to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted CurrencyExchangeRatesList.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CurrencyExchangeRatesLists/batch-modify": {"post": {"description": "Create or update an batch of CurrencyExchangeRatesLists", "operationId": "CurrencyExchangeRatesLists.batch_create_or_update", "summary": "CurrencyExchangeRatesLists.batch_create_or_update", "tags": ["Currency"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CurrencyExchangeRatesLists on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for CurrencyExchangeRatesLists. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new CurrencyExchangeRatesList", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchCurrencyExchangeRatesListInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated CurrencyExchangeRatesLists", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/CurrencyExchangeRatesLists/batch-restore": {"post": {"description": "Restores CurrencyExchangeRatesLists with given list of ids", "operationId": "CurrencyExchangeRatesLists.batch_restore", "summary": "CurrencyExchangeRatesLists.batch_restore", "tags": ["Currency"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of CurrencyExchangeRatesLists on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for CurrencyExchangeRatesLists. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity CurrencyExchangeRatesList to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored CurrencyExchangeRatesList.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/{custom_entity_api_name}/{id}": {"get": {"description": "Returns CustomEntity with given id", "operationId": "{custom_entity_api_name}.get", "summary": "CustomEntities.get", "tags": ["Custom Entity"], "parameters": [{"name": "custom_entity_api_name", "in": "path", "description": "Custom entity api name", "required": true, "schema": {"type": "string"}}, {"name": "id", "in": "path", "description": "ID of CustomEntity to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "CustomEntity data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CustomEntity"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes CustomEntity with given id", "operationId": "{custom_entity_api_name}.delete", "summary": "CustomEntities.delete", "tags": ["Custom Entity"], "parameters": [{"name": "custom_entity_api_name", "in": "path", "description": "Custom entity api name", "required": true, "schema": {"type": "string"}}, {"name": "id", "in": "path", "description": "ID of CustomEntity to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of CustomEntity on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted CustomEntity", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies CustomEntity or {custom_entity_api_name} with given id(s)", "parameters": [{"name": "custom_entity_api_name", "in": "path", "description": "Custom entity api name", "required": true, "schema": {"type": "string"}}, {"name": "id", "in": "path", "description": "ID of CustomEntity to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of CustomEntity on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "{custom_entity_api_name}.update", "summary": "CustomEntities.update", "tags": ["Custom Entity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateCustomEntityInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting CustomEntity", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CustomEntity"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/{custom_entity_api_name}": {"get": {"description": "Returns all defined {custom_entity_api_name}", "operationId": "{custom_entity_api_name}.list", "summary": "CustomEntities.list", "tags": ["Custom Entity"], "parameters": [{"name": "custom_entity_api_name", "in": "path", "description": "Custom entity api name", "required": true, "schema": {"type": "string"}}, {"name": "include-deleted", "in": "query", "description": "if enabled, deleted {custom_entity_api_name} are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of {custom_entity_api_name}", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/CustomEntity"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new CustomEntity", "operationId": "{custom_entity_api_name}.create", "summary": "CustomEntities.create", "tags": ["Custom Entity"], "parameters": [{"name": "custom_entity_api_name", "in": "path", "description": "Custom entity api name", "required": true, "schema": {"type": "string"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of CustomEntity on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new CustomEntity", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createCustomEntityInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created CustomEntity", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CustomEntity"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/{custom_entity_api_name}/batch-delete": {"post": {"description": "Removes {custom_entity_api_name} with given list of ids", "operationId": "{custom_entity_api_name}.batch_delete", "summary": "CustomEntities.batch_delete", "tags": ["Custom Entity"], "parameters": [{"name": "custom_entity_api_name", "in": "path", "description": "Custom entity api name", "required": true, "schema": {"type": "string"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of {custom_entity_api_name} on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for {custom_entity_api_name}. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity CustomEntity to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted CustomEntity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/{custom_entity_api_name}/batch-modify": {"post": {"description": "Create or update an batch of {custom_entity_api_name}", "operationId": "{custom_entity_api_name}.batch_create_or_update", "summary": "CustomEntities.batch_create_or_update", "tags": ["Custom Entity"], "parameters": [{"name": "custom_entity_api_name", "in": "path", "description": "Custom entity api name", "required": true, "schema": {"type": "string"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of {custom_entity_api_name} on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for {custom_entity_api_name}. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new CustomEntity", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchCustomEntityInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated {custom_entity_api_name}", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/{custom_entity_api_name}/batch-restore": {"post": {"description": "Restores {custom_entity_api_name} with given list of ids", "operationId": "{custom_entity_api_name}.batch_restore", "summary": "CustomEntities.batch_restore", "tags": ["Custom Entity"], "parameters": [{"name": "custom_entity_api_name", "in": "path", "description": "Custom entity api name", "required": true, "schema": {"type": "string"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of {custom_entity_api_name} on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for {custom_entity_api_name}. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity CustomEntity to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored CustomEntity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/{custom_entity_type_api_name}/{id}": {"get": {"description": "Returns CustomEntityType with given id", "operationId": "{custom_entity_type_api_name}.get", "summary": "CustomEntityTypes.get", "tags": ["Custom Entity"], "parameters": [{"name": "custom_entity_type_api_name", "in": "path", "description": "Custom entity type api name", "required": true, "schema": {"type": "string"}}, {"name": "id", "in": "path", "description": "ID of CustomEntityType to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "CustomEntityType data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CustomEntityType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes CustomEntityType with given id", "operationId": "{custom_entity_type_api_name}.delete", "summary": "CustomEntityTypes.delete", "tags": ["Custom Entity"], "parameters": [{"name": "custom_entity_type_api_name", "in": "path", "description": "Custom entity type api name", "required": true, "schema": {"type": "string"}}, {"name": "id", "in": "path", "description": "ID of CustomEntityType to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of CustomEntityType on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted CustomEntityType", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies CustomEntityType or {custom_entity_type_api_name} with given id(s)", "parameters": [{"name": "custom_entity_type_api_name", "in": "path", "description": "Custom entity type api name", "required": true, "schema": {"type": "string"}}, {"name": "id", "in": "path", "description": "ID of CustomEntityType to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of CustomEntityType on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "{custom_entity_type_api_name}.update", "summary": "CustomEntityTypes.update", "tags": ["Custom Entity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateCustomEntityTypeInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting CustomEntityType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CustomEntityType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/{custom_entity_type_api_name}": {"get": {"description": "Returns all defined {custom_entity_type_api_name}", "operationId": "{custom_entity_type_api_name}.list", "summary": "CustomEntityTypes.list", "tags": ["Custom Entity"], "parameters": [{"name": "custom_entity_type_api_name", "in": "path", "description": "Custom entity type api name", "required": true, "schema": {"type": "string"}}, {"name": "include-deleted", "in": "query", "description": "if enabled, deleted {custom_entity_type_api_name} are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of {custom_entity_type_api_name}", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/CustomEntityType"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new CustomEntityType", "operationId": "{custom_entity_type_api_name}.create", "summary": "CustomEntityTypes.create", "tags": ["Custom Entity"], "parameters": [{"name": "custom_entity_type_api_name", "in": "path", "description": "Custom entity type api name", "required": true, "schema": {"type": "string"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of CustomEntityType on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new CustomEntityType", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createCustomEntityTypeInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created CustomEntityType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/CustomEntityType"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/{custom_entity_type_api_name}/batch-delete": {"post": {"description": "Removes {custom_entity_type_api_name} with given list of ids", "operationId": "{custom_entity_type_api_name}.batch_delete", "summary": "CustomEntityTypes.batch_delete", "tags": ["Custom Entity"], "parameters": [{"name": "custom_entity_type_api_name", "in": "path", "description": "Custom entity type api name", "required": true, "schema": {"type": "string"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of {custom_entity_type_api_name} on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for {custom_entity_type_api_name}. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity CustomEntityType to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted CustomEntityType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/{custom_entity_type_api_name}/batch-modify": {"post": {"description": "Create or update an batch of {custom_entity_type_api_name}", "operationId": "{custom_entity_type_api_name}.batch_create_or_update", "summary": "CustomEntityTypes.batch_create_or_update", "tags": ["Custom Entity"], "parameters": [{"name": "custom_entity_type_api_name", "in": "path", "description": "Custom entity type api name", "required": true, "schema": {"type": "string"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of {custom_entity_type_api_name} on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for {custom_entity_type_api_name}. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new CustomEntityType", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchCustomEntityTypeInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated {custom_entity_type_api_name}", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/{custom_entity_type_api_name}/batch-restore": {"post": {"description": "Restores {custom_entity_type_api_name} with given list of ids", "operationId": "{custom_entity_type_api_name}.batch_restore", "summary": "CustomEntityTypes.batch_restore", "tags": ["Custom Entity"], "parameters": [{"name": "custom_entity_type_api_name", "in": "path", "description": "Custom entity type api name", "required": true, "schema": {"type": "string"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of {custom_entity_type_api_name} on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for {custom_entity_type_api_name}. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity CustomEntityType to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored CustomEntityType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Data/{id}": {"get": {"description": "Returns Data with given id", "operationId": "Data.get", "summary": "Data.get", "tags": ["Data"], "parameters": [{"name": "id", "in": "path", "description": "ID of Data to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Data data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Data"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Data with given id", "operationId": "Data.delete", "summary": "Data.delete", "tags": ["Data"], "parameters": [{"name": "id", "in": "path", "description": "ID of Data to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Data on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Data", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Data or Data with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Data to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Data on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Data.update", "summary": "Data.update", "tags": ["Data"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateDataInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Data"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Data": {"get": {"description": "Returns all defined Data", "operationId": "Data.list", "summary": "Data.list", "tags": ["Data"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Data are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Data"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Data", "operationId": "Data.create", "summary": "Data.create", "tags": ["Data"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Data on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Data", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createDataInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Data"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Data/batch-delete": {"post": {"description": "Removes Data with given list of ids", "operationId": "Data.batch_delete", "summary": "Data.batch_delete", "tags": ["Data"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Data on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Data. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Data to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Data.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Data/batch-modify": {"post": {"description": "Create or update an batch of Data", "operationId": "Data.batch_create_or_update", "summary": "Data.batch_create_or_update", "tags": ["Data"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Data on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Data. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Data", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchDataInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Data/batch-restore": {"post": {"description": "Restores Data with given list of ids", "operationId": "Data.batch_restore", "summary": "Data.batch_restore", "tags": ["Data"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Data on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Data. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Data to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Data.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Emails/{id}": {"get": {"description": "Returns Email with given id", "operationId": "Emails.get", "summary": "Emails.get", "tags": ["Email"], "parameters": [{"name": "id", "in": "path", "description": "ID of Email to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Email data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Email"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Email with given id", "operationId": "Emails.delete", "summary": "Emails.delete", "tags": ["Email"], "parameters": [{"name": "id", "in": "path", "description": "ID of Email to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Email on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Email", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Email or Emails with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Email to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Email on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Emails.update", "summary": "Emails.update", "tags": ["Email"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateEmailInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Email", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Email"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Emails": {"get": {"description": "Returns all defined Emails", "operationId": "Emails.list", "summary": "Emails.list", "tags": ["Email"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Emails are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Emails", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Email"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Email", "operationId": "Emails.create", "summary": "Emails.create", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Email on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Email", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createEmailInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Email", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Email"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Emails/batch-delete": {"post": {"description": "Removes Emails with given list of ids", "operationId": "Emails.batch_delete", "summary": "Emails.batch_delete", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Emails on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Emails. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Email to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Email.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Emails/batch-modify": {"post": {"description": "Create or update an batch of Emails", "operationId": "Emails.batch_create_or_update", "summary": "Emails.batch_create_or_update", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Emails on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Emails. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Email", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchEmailInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Emails", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Emails/batch-restore": {"post": {"description": "Restores Emails with given list of ids", "operationId": "Emails.batch_restore", "summary": "Emails.batch_restore", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Emails on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Emails. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Email to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Email.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailContentSharingClientRelations/{id}": {"get": {"description": "Returns EmailContentSharingClientRelation with given id", "operationId": "EmailContentSharingClientRelations.get", "summary": "EmailContentSharingClientRelations.get", "tags": ["Email"], "parameters": [{"name": "id", "in": "path", "description": "ID of EmailContentSharingClientRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "EmailContentSharingClientRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailContentSharingClientRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes EmailContentSharingClientRelation with given id", "operationId": "EmailContentSharingClientRelations.delete", "summary": "EmailContentSharingClientRelations.delete", "tags": ["Email"], "parameters": [{"name": "id", "in": "path", "description": "ID of EmailContentSharingClientRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EmailContentSharingClientRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted EmailContentSharingClientRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies EmailContentSharingClientRelation or EmailContentSharingClientRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of EmailContentSharingClientRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EmailContentSharingClientRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "EmailContentSharingClientRelations.update", "summary": "EmailContentSharingClientRelations.update", "tags": ["Email"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateEmailContentSharingClientRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting EmailContentSharingClientRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailContentSharingClientRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailContentSharingClientRelations": {"get": {"description": "Returns all defined EmailContentSharingClientRelations", "operationId": "EmailContentSharingClientRelations.list", "summary": "EmailContentSharingClientRelations.list", "tags": ["Email"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted EmailContentSharingClientRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of EmailContentSharingClientRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/EmailContentSharingClientRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new EmailContentSharingClientRelation", "operationId": "EmailContentSharingClientRelations.create", "summary": "EmailContentSharingClientRelations.create", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailContentSharingClientRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EmailContentSharingClientRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createEmailContentSharingClientRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created EmailContentSharingClientRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailContentSharingClientRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailContentSharingClientRelations/batch-delete": {"post": {"description": "Removes EmailContentSharingClientRelations with given list of ids", "operationId": "EmailContentSharingClientRelations.batch_delete", "summary": "EmailContentSharingClientRelations.batch_delete", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailContentSharingClientRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailContentSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EmailContentSharingClientRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted EmailContentSharingClientRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailContentSharingClientRelations/batch-modify": {"post": {"description": "Create or update an batch of EmailContentSharingClientRelations", "operationId": "EmailContentSharingClientRelations.batch_create_or_update", "summary": "EmailContentSharingClientRelations.batch_create_or_update", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailContentSharingClientRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailContentSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EmailContentSharingClientRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchEmailContentSharingClientRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated EmailContentSharingClientRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailContentSharingClientRelations/batch-restore": {"post": {"description": "Restores EmailContentSharingClientRelations with given list of ids", "operationId": "EmailContentSharingClientRelations.batch_restore", "summary": "EmailContentSharingClientRelations.batch_restore", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailContentSharingClientRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailContentSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EmailContentSharingClientRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored EmailContentSharingClientRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailContentSharingSalesUnitRelations/{id}": {"get": {"description": "Returns EmailContentSharingSalesUnitRelation with given id", "operationId": "EmailContentSharingSalesUnitRelations.get", "summary": "EmailContentSharingSalesUnitRelations.get", "tags": ["Email"], "parameters": [{"name": "id", "in": "path", "description": "ID of EmailContentSharingSalesUnitRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "EmailContentSharingSalesUnitRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailContentSharingSalesUnitRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes EmailContentSharingSalesUnitRelation with given id", "operationId": "EmailContentSharingSalesUnitRelations.delete", "summary": "EmailContentSharingSalesUnitRelations.delete", "tags": ["Email"], "parameters": [{"name": "id", "in": "path", "description": "ID of EmailContentSharingSalesUnitRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EmailContentSharingSalesUnitRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted EmailContentSharingSalesUnitRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies EmailContentSharingSalesUnitRelation or EmailContentSharingSalesUnitRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of EmailContentSharingSalesUnitRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EmailContentSharingSalesUnitRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "EmailContentSharingSalesUnitRelations.update", "summary": "EmailContentSharingSalesUnitRelations.update", "tags": ["Email"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateEmailContentSharingSalesUnitRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting EmailContentSharingSalesUnitRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailContentSharingSalesUnitRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailContentSharingSalesUnitRelations": {"get": {"description": "Returns all defined EmailContentSharingSalesUnitRelations", "operationId": "EmailContentSharingSalesUnitRelations.list", "summary": "EmailContentSharingSalesUnitRelations.list", "tags": ["Email"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted EmailContentSharingSalesUnitRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of EmailContentSharingSalesUnitRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/EmailContentSharingSalesUnitRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new EmailContentSharingSalesUnitRelation", "operationId": "EmailContentSharingSalesUnitRelations.create", "summary": "EmailContentSharingSalesUnitRelations.create", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailContentSharingSalesUnitRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EmailContentSharingSalesUnitRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createEmailContentSharingSalesUnitRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created EmailContentSharingSalesUnitRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailContentSharingSalesUnitRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailContentSharingSalesUnitRelations/batch-delete": {"post": {"description": "Removes EmailContentSharingSalesUnitRelations with given list of ids", "operationId": "EmailContentSharingSalesUnitRelations.batch_delete", "summary": "EmailContentSharingSalesUnitRelations.batch_delete", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailContentSharingSalesUnitRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailContentSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EmailContentSharingSalesUnitRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted EmailContentSharingSalesUnitRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailContentSharingSalesUnitRelations/batch-modify": {"post": {"description": "Create or update an batch of EmailContentSharingSalesUnitRelations", "operationId": "EmailContentSharingSalesUnitRelations.batch_create_or_update", "summary": "EmailContentSharingSalesUnitRelations.batch_create_or_update", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailContentSharingSalesUnitRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailContentSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EmailContentSharingSalesUnitRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchEmailContentSharingSalesUnitRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated EmailContentSharingSalesUnitRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailContentSharingSalesUnitRelations/batch-restore": {"post": {"description": "Restores EmailContentSharingSalesUnitRelations with given list of ids", "operationId": "EmailContentSharingSalesUnitRelations.batch_restore", "summary": "EmailContentSharingSalesUnitRelations.batch_restore", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailContentSharingSalesUnitRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailContentSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EmailContentSharingSalesUnitRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored EmailContentSharingSalesUnitRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailEvents/{id}": {"get": {"description": "Returns EmailEvent with given id", "operationId": "EmailEvents.get", "summary": "EmailEvents.get", "tags": ["Email"], "parameters": [{"name": "id", "in": "path", "description": "ID of EmailEvent to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "EmailEvent data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailEvent"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes EmailEvent with given id", "operationId": "EmailEvents.delete", "summary": "EmailEvents.delete", "tags": ["Email"], "parameters": [{"name": "id", "in": "path", "description": "ID of EmailEvent to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EmailEvent on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted EmailEvent", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies EmailEvent or EmailEvents with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of EmailEvent to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EmailEvent on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "EmailEvents.update", "summary": "EmailEvents.update", "tags": ["Email"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateEmailEventInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting EmailEvent", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailEvent"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailEvents": {"get": {"description": "Returns all defined EmailEvents", "operationId": "EmailEvents.list", "summary": "EmailEvents.list", "tags": ["Email"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted EmailEvents are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of EmailEvents", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/EmailEvent"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new EmailEvent", "operationId": "EmailEvents.create", "summary": "EmailEvents.create", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailEvent on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EmailEvent", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createEmailEventInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created EmailEvent", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailEvent"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailEvents/batch-delete": {"post": {"description": "Removes EmailEvents with given list of ids", "operationId": "EmailEvents.batch_delete", "summary": "EmailEvents.batch_delete", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailEvents on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailEvents. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EmailEvent to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted EmailEvent.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailEvents/batch-modify": {"post": {"description": "Create or update an batch of EmailEvents", "operationId": "EmailEvents.batch_create_or_update", "summary": "EmailEvents.batch_create_or_update", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailEvents on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailEvents. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EmailEvent", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchEmailEventInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated EmailEvents", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailEvents/batch-restore": {"post": {"description": "Restores EmailEvents with given list of ids", "operationId": "EmailEvents.batch_restore", "summary": "EmailEvents.batch_restore", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailEvents on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailEvents. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EmailEvent to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored EmailEvent.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailMailboxRelations/{id}": {"get": {"description": "Returns EmailMailboxRelation with given id", "operationId": "EmailMailboxRelations.get", "summary": "EmailMailboxRelations.get", "tags": ["Email"], "parameters": [{"name": "id", "in": "path", "description": "ID of EmailMailboxRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "EmailMailboxRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailMailboxRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes EmailMailboxRelation with given id", "operationId": "EmailMailboxRelations.delete", "summary": "EmailMailboxRelations.delete", "tags": ["Email"], "parameters": [{"name": "id", "in": "path", "description": "ID of EmailMailboxRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EmailMailboxRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted EmailMailboxRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies EmailMailboxRelation or EmailMailboxRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of EmailMailboxRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EmailMailboxRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "EmailMailboxRelations.update", "summary": "EmailMailboxRelations.update", "tags": ["Email"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateEmailMailboxRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting EmailMailboxRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailMailboxRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailMailboxRelations": {"get": {"description": "Returns all defined EmailMailboxRelations", "operationId": "EmailMailboxRelations.list", "summary": "EmailMailboxRelations.list", "tags": ["Email"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted EmailMailboxRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of EmailMailboxRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/EmailMailboxRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new EmailMailboxRelation", "operationId": "EmailMailboxRelations.create", "summary": "EmailMailboxRelations.create", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailMailboxRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EmailMailboxRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createEmailMailboxRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created EmailMailboxRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailMailboxRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailMailboxRelations/batch-delete": {"post": {"description": "Removes EmailMailboxRelations with given list of ids", "operationId": "EmailMailboxRelations.batch_delete", "summary": "EmailMailboxRelations.batch_delete", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailMailboxRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailMailboxRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EmailMailboxRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted EmailMailboxRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailMailboxRelations/batch-modify": {"post": {"description": "Create or update an batch of EmailMailboxRelations", "operationId": "EmailMailboxRelations.batch_create_or_update", "summary": "EmailMailboxRelations.batch_create_or_update", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailMailboxRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailMailboxRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EmailMailboxRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchEmailMailboxRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated EmailMailboxRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailMailboxRelations/batch-restore": {"post": {"description": "Restores EmailMailboxRelations with given list of ids", "operationId": "EmailMailboxRelations.batch_restore", "summary": "EmailMailboxRelations.batch_restore", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailMailboxRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailMailboxRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EmailMailboxRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored EmailMailboxRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailSequences/{id}": {"get": {"description": "Returns EmailSequence with given id", "operationId": "EmailSequences.get", "summary": "EmailSequences.get", "tags": ["Email Sequence"], "parameters": [{"name": "id", "in": "path", "description": "ID of EmailSequence to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "EmailSequence data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailSequence"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes EmailSequence with given id", "operationId": "EmailSequences.delete", "summary": "EmailSequences.delete", "tags": ["Email Sequence"], "parameters": [{"name": "id", "in": "path", "description": "ID of EmailSequence to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EmailSequence on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted EmailSequence", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies EmailSequence or EmailSequences with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of EmailSequence to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EmailSequence on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "EmailSequences.update", "summary": "EmailSequences.update", "tags": ["Email Sequence"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateEmailSequenceInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting EmailSequence", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailSequence"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailSequences": {"get": {"description": "Returns all defined EmailSequences", "operationId": "EmailSequences.list", "summary": "EmailSequences.list", "tags": ["Email Sequence"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted EmailSequences are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of EmailSequences", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/EmailSequence"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new EmailSequence", "operationId": "EmailSequences.create", "summary": "EmailSequences.create", "tags": ["Email Sequence"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailSequence on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EmailSequence", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createEmailSequenceInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created EmailSequence", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailSequence"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailSequences/batch-delete": {"post": {"description": "Removes EmailSequences with given list of ids", "operationId": "EmailSequences.batch_delete", "summary": "EmailSequences.batch_delete", "tags": ["Email Sequence"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailSequences on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailSequences. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EmailSequence to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted EmailSequence.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailSequences/batch-modify": {"post": {"description": "Create or update an batch of EmailSequences", "operationId": "EmailSequences.batch_create_or_update", "summary": "EmailSequences.batch_create_or_update", "tags": ["Email Sequence"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailSequences on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailSequences. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EmailSequence", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchEmailSequenceInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated EmailSequences", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailSequences/batch-restore": {"post": {"description": "Restores EmailSequences with given list of ids", "operationId": "EmailSequences.batch_restore", "summary": "EmailSequences.batch_restore", "tags": ["Email Sequence"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailSequences on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailSequences. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EmailSequence to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored EmailSequence.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailSequenceActivityLogs/{id}": {"get": {"description": "Returns EmailSequenceActivityLog with given id", "operationId": "EmailSequenceActivityLogs.get", "summary": "EmailSequenceActivityLogs.get", "tags": ["Email Sequence"], "parameters": [{"name": "id", "in": "path", "description": "ID of EmailSequenceActivityLog to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "EmailSequenceActivityLog data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailSequenceActivityLog"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes EmailSequenceActivityLog with given id", "operationId": "EmailSequenceActivityLogs.delete", "summary": "EmailSequenceActivityLogs.delete", "tags": ["Email Sequence"], "parameters": [{"name": "id", "in": "path", "description": "ID of EmailSequenceActivityLog to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EmailSequenceActivityLog on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted EmailSequenceActivityLog", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies EmailSequenceActivityLog or EmailSequenceActivityLogs with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of EmailSequenceActivityLog to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EmailSequenceActivityLog on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "EmailSequenceActivityLogs.update", "summary": "EmailSequenceActivityLogs.update", "tags": ["Email Sequence"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateEmailSequenceActivityLogInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting EmailSequenceActivityLog", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailSequenceActivityLog"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailSequenceActivityLogs": {"get": {"description": "Returns all defined EmailSequenceActivityLogs", "operationId": "EmailSequenceActivityLogs.list", "summary": "EmailSequenceActivityLogs.list", "tags": ["Email Sequence"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted EmailSequenceActivityLogs are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of EmailSequenceActivityLogs", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/EmailSequenceActivityLog"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new EmailSequenceActivityLog", "operationId": "EmailSequenceActivityLogs.create", "summary": "EmailSequenceActivityLogs.create", "tags": ["Email Sequence"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailSequenceActivityLog on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EmailSequenceActivityLog", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createEmailSequenceActivityLogInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created EmailSequenceActivityLog", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailSequenceActivityLog"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailSequenceActivityLogs/batch-delete": {"post": {"description": "Removes EmailSequenceActivityLogs with given list of ids", "operationId": "EmailSequenceActivityLogs.batch_delete", "summary": "EmailSequenceActivityLogs.batch_delete", "tags": ["Email Sequence"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailSequenceActivityLogs on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailSequenceActivityLogs. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EmailSequenceActivityLog to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted EmailSequenceActivityLog.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailSequenceActivityLogs/batch-modify": {"post": {"description": "Create or update an batch of EmailSequenceActivityLogs", "operationId": "EmailSequenceActivityLogs.batch_create_or_update", "summary": "EmailSequenceActivityLogs.batch_create_or_update", "tags": ["Email Sequence"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailSequenceActivityLogs on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailSequenceActivityLogs. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EmailSequenceActivityLog", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchEmailSequenceActivityLogInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated EmailSequenceActivityLogs", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailSequenceActivityLogs/batch-restore": {"post": {"description": "Restores EmailSequenceActivityLogs with given list of ids", "operationId": "EmailSequenceActivityLogs.batch_restore", "summary": "EmailSequenceActivityLogs.batch_restore", "tags": ["Email Sequence"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailSequenceActivityLogs on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailSequenceActivityLogs. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EmailSequenceActivityLog to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored EmailSequenceActivityLog.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailSequenceActivityLogLines/{id}": {"get": {"description": "Returns EmailSequenceActivityLogLine with given id", "operationId": "EmailSequenceActivityLogLines.get", "summary": "EmailSequenceActivityLogLines.get", "tags": ["Email Sequence"], "parameters": [{"name": "id", "in": "path", "description": "ID of EmailSequenceActivityLogLine to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "EmailSequenceActivityLogLine data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailSequenceActivityLogLine"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes EmailSequenceActivityLogLine with given id", "operationId": "EmailSequenceActivityLogLines.delete", "summary": "EmailSequenceActivityLogLines.delete", "tags": ["Email Sequence"], "parameters": [{"name": "id", "in": "path", "description": "ID of EmailSequenceActivityLogLine to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EmailSequenceActivityLogLine on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted EmailSequenceActivityLogLine", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies EmailSequenceActivityLogLine or EmailSequenceActivityLogLines with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of EmailSequenceActivityLogLine to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EmailSequenceActivityLogLine on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "EmailSequenceActivityLogLines.update", "summary": "EmailSequenceActivityLogLines.update", "tags": ["Email Sequence"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateEmailSequenceActivityLogLineInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting EmailSequenceActivityLogLine", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailSequenceActivityLogLine"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailSequenceActivityLogLines": {"get": {"description": "Returns all defined EmailSequenceActivityLogLines", "operationId": "EmailSequenceActivityLogLines.list", "summary": "EmailSequenceActivityLogLines.list", "tags": ["Email Sequence"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted EmailSequenceActivityLogLines are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of EmailSequenceActivityLogLines", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/EmailSequenceActivityLogLine"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new EmailSequenceActivityLogLine", "operationId": "EmailSequenceActivityLogLines.create", "summary": "EmailSequenceActivityLogLines.create", "tags": ["Email Sequence"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailSequenceActivityLogLine on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EmailSequenceActivityLogLine", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createEmailSequenceActivityLogLineInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created EmailSequenceActivityLogLine", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailSequenceActivityLogLine"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailSequenceActivityLogLines/batch-delete": {"post": {"description": "Removes EmailSequenceActivityLogLines with given list of ids", "operationId": "EmailSequenceActivityLogLines.batch_delete", "summary": "EmailSequenceActivityLogLines.batch_delete", "tags": ["Email Sequence"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailSequenceActivityLogLines on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailSequenceActivityLogLines. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EmailSequenceActivityLogLine to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted EmailSequenceActivityLogLine.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailSequenceActivityLogLines/batch-modify": {"post": {"description": "Create or update an batch of EmailSequenceActivityLogLines", "operationId": "EmailSequenceActivityLogLines.batch_create_or_update", "summary": "EmailSequenceActivityLogLines.batch_create_or_update", "tags": ["Email Sequence"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailSequenceActivityLogLines on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailSequenceActivityLogLines. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EmailSequenceActivityLogLine", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchEmailSequenceActivityLogLineInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated EmailSequenceActivityLogLines", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailSequenceActivityLogLines/batch-restore": {"post": {"description": "Restores EmailSequenceActivityLogLines with given list of ids", "operationId": "EmailSequenceActivityLogLines.batch_restore", "summary": "EmailSequenceActivityLogLines.batch_restore", "tags": ["Email Sequence"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailSequenceActivityLogLines on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailSequenceActivityLogLines. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EmailSequenceActivityLogLine to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored EmailSequenceActivityLogLine.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailSequenceEnrolleds/{id}": {"get": {"description": "Returns EmailSequenceEnrolled with given id", "operationId": "EmailSequenceEnrolleds.get", "summary": "EmailSequenceEnrolleds.get", "tags": ["Email Sequence"], "parameters": [{"name": "id", "in": "path", "description": "ID of EmailSequenceEnrolled to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "EmailSequenceEnrolled data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailSequenceEnrolled"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes EmailSequenceEnrolled with given id", "operationId": "EmailSequenceEnrolleds.delete", "summary": "EmailSequenceEnrolleds.delete", "tags": ["Email Sequence"], "parameters": [{"name": "id", "in": "path", "description": "ID of EmailSequenceEnrolled to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EmailSequenceEnrolled on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted EmailSequenceEnrolled", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies EmailSequenceEnrolled or EmailSequenceEnrolleds with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of EmailSequenceEnrolled to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EmailSequenceEnrolled on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "EmailSequenceEnrolleds.update", "summary": "EmailSequenceEnrolleds.update", "tags": ["Email Sequence"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateEmailSequenceEnrolledInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting EmailSequenceEnrolled", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailSequenceEnrolled"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailSequenceEnrolleds": {"get": {"description": "Returns all defined EmailSequenceEnrolleds", "operationId": "EmailSequenceEnrolleds.list", "summary": "EmailSequenceEnrolleds.list", "tags": ["Email Sequence"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted EmailSequenceEnrolleds are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of EmailSequenceEnrolleds", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/EmailSequenceEnrolled"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new EmailSequenceEnrolled", "operationId": "EmailSequenceEnrolleds.create", "summary": "EmailSequenceEnrolleds.create", "tags": ["Email Sequence"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailSequenceEnrolled on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EmailSequenceEnrolled", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createEmailSequenceEnrolledInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created EmailSequenceEnrolled", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailSequenceEnrolled"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailSequenceEnrolleds/batch-delete": {"post": {"description": "Removes EmailSequenceEnrolleds with given list of ids", "operationId": "EmailSequenceEnrolleds.batch_delete", "summary": "EmailSequenceEnrolleds.batch_delete", "tags": ["Email Sequence"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailSequenceEnrolleds on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailSequenceEnrolleds. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EmailSequenceEnrolled to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted EmailSequenceEnrolled.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailSequenceEnrolleds/batch-modify": {"post": {"description": "Create or update an batch of EmailSequenceEnrolleds", "operationId": "EmailSequenceEnrolleds.batch_create_or_update", "summary": "EmailSequenceEnrolleds.batch_create_or_update", "tags": ["Email Sequence"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailSequenceEnrolleds on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailSequenceEnrolleds. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EmailSequenceEnrolled", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchEmailSequenceEnrolledInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated EmailSequenceEnrolleds", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailSequenceEnrolleds/batch-restore": {"post": {"description": "Restores EmailSequenceEnrolleds with given list of ids", "operationId": "EmailSequenceEnrolleds.batch_restore", "summary": "EmailSequenceEnrolleds.batch_restore", "tags": ["Email Sequence"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailSequenceEnrolleds on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailSequenceEnrolleds. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EmailSequenceEnrolled to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored EmailSequenceEnrolled.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailTemplates/{id}": {"get": {"description": "Returns EmailTemplate with given id", "operationId": "EmailTemplates.get", "summary": "EmailTemplates.get", "tags": ["Email"], "parameters": [{"name": "id", "in": "path", "description": "ID of EmailTemplate to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "EmailTemplate data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailTemplate"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes EmailTemplate with given id", "operationId": "EmailTemplates.delete", "summary": "EmailTemplates.delete", "tags": ["Email"], "parameters": [{"name": "id", "in": "path", "description": "ID of EmailTemplate to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EmailTemplate on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted EmailTemplate", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies EmailTemplate or EmailTemplates with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of EmailTemplate to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EmailTemplate on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "EmailTemplates.update", "summary": "EmailTemplates.update", "tags": ["Email"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateEmailTemplateInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting EmailTemplate", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailTemplate"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailTemplates": {"get": {"description": "Returns all defined EmailTemplates", "operationId": "EmailTemplates.list", "summary": "EmailTemplates.list", "tags": ["Email"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted EmailTemplates are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of EmailTemplates", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/EmailTemplate"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new EmailTemplate", "operationId": "EmailTemplates.create", "summary": "EmailTemplates.create", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailTemplate on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EmailTemplate", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createEmailTemplateInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created EmailTemplate", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailTemplate"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailTemplates/batch-delete": {"post": {"description": "Removes EmailTemplates with given list of ids", "operationId": "EmailTemplates.batch_delete", "summary": "EmailTemplates.batch_delete", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailTemplates on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailTemplates. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EmailTemplate to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted EmailTemplate.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailTemplates/batch-modify": {"post": {"description": "Create or update an batch of EmailTemplates", "operationId": "EmailTemplates.batch_create_or_update", "summary": "EmailTemplates.batch_create_or_update", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailTemplates on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailTemplates. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EmailTemplate", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchEmailTemplateInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated EmailTemplates", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailTemplates/batch-restore": {"post": {"description": "Restores EmailTemplates with given list of ids", "operationId": "EmailTemplates.batch_restore", "summary": "EmailTemplates.batch_restore", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailTemplates on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailTemplates. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EmailTemplate to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored EmailTemplate.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailTemplateFolders/{id}": {"get": {"description": "Returns EmailTemplateFolder with given id", "operationId": "EmailTemplateFolders.get", "summary": "EmailTemplateFolders.get", "tags": ["Email"], "parameters": [{"name": "id", "in": "path", "description": "ID of EmailTemplateFolder to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "EmailTemplateFolder data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailTemplateFolder"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes EmailTemplateFolder with given id", "operationId": "EmailTemplateFolders.delete", "summary": "EmailTemplateFolders.delete", "tags": ["Email"], "parameters": [{"name": "id", "in": "path", "description": "ID of EmailTemplateFolder to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EmailTemplateFolder on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted EmailTemplateFolder", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies EmailTemplateFolder or EmailTemplateFolders with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of EmailTemplateFolder to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EmailTemplateFolder on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "EmailTemplateFolders.update", "summary": "EmailTemplateFolders.update", "tags": ["Email"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateEmailTemplateFolderInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting EmailTemplateFolder", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailTemplateFolder"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailTemplateFolders": {"get": {"description": "Returns all defined EmailTemplateFolders", "operationId": "EmailTemplateFolders.list", "summary": "EmailTemplateFolders.list", "tags": ["Email"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted EmailTemplateFolders are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of EmailTemplateFolders", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/EmailTemplateFolder"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new EmailTemplateFolder", "operationId": "EmailTemplateFolders.create", "summary": "EmailTemplateFolders.create", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailTemplateFolder on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EmailTemplateFolder", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createEmailTemplateFolderInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created EmailTemplateFolder", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailTemplateFolder"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailTemplateFolders/batch-delete": {"post": {"description": "Removes EmailTemplateFolders with given list of ids", "operationId": "EmailTemplateFolders.batch_delete", "summary": "EmailTemplateFolders.batch_delete", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailTemplateFolders on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailTemplateFolders. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EmailTemplateFolder to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted EmailTemplateFolder.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailTemplateFolders/batch-modify": {"post": {"description": "Create or update an batch of EmailTemplateFolders", "operationId": "EmailTemplateFolders.batch_create_or_update", "summary": "EmailTemplateFolders.batch_create_or_update", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailTemplateFolders on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailTemplateFolders. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EmailTemplateFolder", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchEmailTemplateFolderInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated EmailTemplateFolders", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailTemplateFolders/batch-restore": {"post": {"description": "Restores EmailTemplateFolders with given list of ids", "operationId": "EmailTemplateFolders.batch_restore", "summary": "EmailTemplateFolders.batch_restore", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailTemplateFolders on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailTemplateFolders. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EmailTemplateFolder to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored EmailTemplateFolder.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailTemplateSharingClientRelations/{id}": {"get": {"description": "Returns EmailTemplateSharingClientRelation with given id", "operationId": "EmailTemplateSharingClientRelations.get", "summary": "EmailTemplateSharingClientRelations.get", "tags": ["Email"], "parameters": [{"name": "id", "in": "path", "description": "ID of EmailTemplateSharingClientRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "EmailTemplateSharingClientRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailTemplateSharingClientRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes EmailTemplateSharingClientRelation with given id", "operationId": "EmailTemplateSharingClientRelations.delete", "summary": "EmailTemplateSharingClientRelations.delete", "tags": ["Email"], "parameters": [{"name": "id", "in": "path", "description": "ID of EmailTemplateSharingClientRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EmailTemplateSharingClientRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted EmailTemplateSharingClientRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies EmailTemplateSharingClientRelation or EmailTemplateSharingClientRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of EmailTemplateSharingClientRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EmailTemplateSharingClientRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "EmailTemplateSharingClientRelations.update", "summary": "EmailTemplateSharingClientRelations.update", "tags": ["Email"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateEmailTemplateSharingClientRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting EmailTemplateSharingClientRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailTemplateSharingClientRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailTemplateSharingClientRelations": {"get": {"description": "Returns all defined EmailTemplateSharingClientRelations", "operationId": "EmailTemplateSharingClientRelations.list", "summary": "EmailTemplateSharingClientRelations.list", "tags": ["Email"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted EmailTemplateSharingClientRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of EmailTemplateSharingClientRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/EmailTemplateSharingClientRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new EmailTemplateSharingClientRelation", "operationId": "EmailTemplateSharingClientRelations.create", "summary": "EmailTemplateSharingClientRelations.create", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailTemplateSharingClientRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EmailTemplateSharingClientRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createEmailTemplateSharingClientRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created EmailTemplateSharingClientRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailTemplateSharingClientRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailTemplateSharingClientRelations/batch-delete": {"post": {"description": "Removes EmailTemplateSharingClientRelations with given list of ids", "operationId": "EmailTemplateSharingClientRelations.batch_delete", "summary": "EmailTemplateSharingClientRelations.batch_delete", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailTemplateSharingClientRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailTemplateSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EmailTemplateSharingClientRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted EmailTemplateSharingClientRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailTemplateSharingClientRelations/batch-modify": {"post": {"description": "Create or update an batch of EmailTemplateSharingClientRelations", "operationId": "EmailTemplateSharingClientRelations.batch_create_or_update", "summary": "EmailTemplateSharingClientRelations.batch_create_or_update", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailTemplateSharingClientRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailTemplateSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EmailTemplateSharingClientRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchEmailTemplateSharingClientRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated EmailTemplateSharingClientRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailTemplateSharingClientRelations/batch-restore": {"post": {"description": "Restores EmailTemplateSharingClientRelations with given list of ids", "operationId": "EmailTemplateSharingClientRelations.batch_restore", "summary": "EmailTemplateSharingClientRelations.batch_restore", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailTemplateSharingClientRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailTemplateSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EmailTemplateSharingClientRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored EmailTemplateSharingClientRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailTemplateSharingSalesUnitRelations/{id}": {"get": {"description": "Returns EmailTemplateSharingSalesUnitRelation with given id", "operationId": "EmailTemplateSharingSalesUnitRelations.get", "summary": "EmailTemplateSharingSalesUnitRelations.get", "tags": ["Email"], "parameters": [{"name": "id", "in": "path", "description": "ID of EmailTemplateSharingSalesUnitRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "EmailTemplateSharingSalesUnitRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailTemplateSharingSalesUnitRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes EmailTemplateSharingSalesUnitRelation with given id", "operationId": "EmailTemplateSharingSalesUnitRelations.delete", "summary": "EmailTemplateSharingSalesUnitRelations.delete", "tags": ["Email"], "parameters": [{"name": "id", "in": "path", "description": "ID of EmailTemplateSharingSalesUnitRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EmailTemplateSharingSalesUnitRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted EmailTemplateSharingSalesUnitRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies EmailTemplateSharingSalesUnitRelation or EmailTemplateSharingSalesUnitRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of EmailTemplateSharingSalesUnitRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EmailTemplateSharingSalesUnitRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "EmailTemplateSharingSalesUnitRelations.update", "summary": "EmailTemplateSharingSalesUnitRelations.update", "tags": ["Email"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateEmailTemplateSharingSalesUnitRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting EmailTemplateSharingSalesUnitRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailTemplateSharingSalesUnitRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailTemplateSharingSalesUnitRelations": {"get": {"description": "Returns all defined EmailTemplateSharingSalesUnitRelations", "operationId": "EmailTemplateSharingSalesUnitRelations.list", "summary": "EmailTemplateSharingSalesUnitRelations.list", "tags": ["Email"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted EmailTemplateSharingSalesUnitRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of EmailTemplateSharingSalesUnitRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/EmailTemplateSharingSalesUnitRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new EmailTemplateSharingSalesUnitRelation", "operationId": "EmailTemplateSharingSalesUnitRelations.create", "summary": "EmailTemplateSharingSalesUnitRelations.create", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailTemplateSharingSalesUnitRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EmailTemplateSharingSalesUnitRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createEmailTemplateSharingSalesUnitRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created EmailTemplateSharingSalesUnitRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailTemplateSharingSalesUnitRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailTemplateSharingSalesUnitRelations/batch-delete": {"post": {"description": "Removes EmailTemplateSharingSalesUnitRelations with given list of ids", "operationId": "EmailTemplateSharingSalesUnitRelations.batch_delete", "summary": "EmailTemplateSharingSalesUnitRelations.batch_delete", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailTemplateSharingSalesUnitRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailTemplateSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EmailTemplateSharingSalesUnitRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted EmailTemplateSharingSalesUnitRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailTemplateSharingSalesUnitRelations/batch-modify": {"post": {"description": "Create or update an batch of EmailTemplateSharingSalesUnitRelations", "operationId": "EmailTemplateSharingSalesUnitRelations.batch_create_or_update", "summary": "EmailTemplateSharingSalesUnitRelations.batch_create_or_update", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailTemplateSharingSalesUnitRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailTemplateSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EmailTemplateSharingSalesUnitRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchEmailTemplateSharingSalesUnitRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated EmailTemplateSharingSalesUnitRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailTemplateSharingSalesUnitRelations/batch-restore": {"post": {"description": "Restores EmailTemplateSharingSalesUnitRelations with given list of ids", "operationId": "EmailTemplateSharingSalesUnitRelations.batch_restore", "summary": "EmailTemplateSharingSalesUnitRelations.batch_restore", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailTemplateSharingSalesUnitRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailTemplateSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EmailTemplateSharingSalesUnitRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored EmailTemplateSharingSalesUnitRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailThreadMailboxClientReadStates/{id}": {"get": {"description": "Returns EmailThreadMailboxClientReadState with given id", "operationId": "EmailThreadMailboxClientReadStates.get", "summary": "EmailThreadMailboxClientReadStates.get", "tags": ["Email"], "parameters": [{"name": "id", "in": "path", "description": "ID of EmailThreadMailboxClientReadState to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "EmailThreadMailboxClientReadState data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailThreadMailboxClientReadState"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes EmailThreadMailboxClientReadState with given id", "operationId": "EmailThreadMailboxClientReadStates.delete", "summary": "EmailThreadMailboxClientReadStates.delete", "tags": ["Email"], "parameters": [{"name": "id", "in": "path", "description": "ID of EmailThreadMailboxClientReadState to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EmailThreadMailboxClientReadState on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted EmailThreadMailboxClientReadState", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies EmailThreadMailboxClientReadState or EmailThreadMailboxClientReadStates with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of EmailThreadMailboxClientReadState to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EmailThreadMailboxClientReadState on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "EmailThreadMailboxClientReadStates.update", "summary": "EmailThreadMailboxClientReadStates.update", "tags": ["Email"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateEmailThreadMailboxClientReadStateInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting EmailThreadMailboxClientReadState", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailThreadMailboxClientReadState"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailThreadMailboxClientReadStates": {"get": {"description": "Returns all defined EmailThreadMailboxClientReadStates", "operationId": "EmailThreadMailboxClientReadStates.list", "summary": "EmailThreadMailboxClientReadStates.list", "tags": ["Email"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted EmailThreadMailboxClientReadStates are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of EmailThreadMailboxClientReadStates", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/EmailThreadMailboxClientReadState"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new EmailThreadMailboxClientReadState", "operationId": "EmailThreadMailboxClientReadStates.create", "summary": "EmailThreadMailboxClientReadStates.create", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailThreadMailboxClientReadState on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EmailThreadMailboxClientReadState", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createEmailThreadMailboxClientReadStateInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created EmailThreadMailboxClientReadState", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EmailThreadMailboxClientReadState"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailThreadMailboxClientReadStates/batch-delete": {"post": {"description": "Removes EmailThreadMailboxClientReadStates with given list of ids", "operationId": "EmailThreadMailboxClientReadStates.batch_delete", "summary": "EmailThreadMailboxClientReadStates.batch_delete", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailThreadMailboxClientReadStates on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailThreadMailboxClientReadStates. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EmailThreadMailboxClientReadState to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted EmailThreadMailboxClientReadState.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailThreadMailboxClientReadStates/batch-modify": {"post": {"description": "Create or update an batch of EmailThreadMailboxClientReadStates", "operationId": "EmailThreadMailboxClientReadStates.batch_create_or_update", "summary": "EmailThreadMailboxClientReadStates.batch_create_or_update", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailThreadMailboxClientReadStates on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailThreadMailboxClientReadStates. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EmailThreadMailboxClientReadState", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchEmailThreadMailboxClientReadStateInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated EmailThreadMailboxClientReadStates", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EmailThreadMailboxClientReadStates/batch-restore": {"post": {"description": "Restores EmailThreadMailboxClientReadStates with given list of ids", "operationId": "EmailThreadMailboxClientReadStates.batch_restore", "summary": "EmailThreadMailboxClientReadStates.batch_restore", "tags": ["Email"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EmailThreadMailboxClientReadStates on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EmailThreadMailboxClientReadStates. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EmailThreadMailboxClientReadState to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored EmailThreadMailboxClientReadState.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Entities/{id}": {"get": {"description": "Returns Entity with given id", "operationId": "Entities.get", "summary": "Entities.get", "tags": ["Custom Entity"], "parameters": [{"name": "id", "in": "path", "description": "ID of Entity to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Entity data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Entity"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Entities": {"get": {"description": "Returns all defined Entities", "operationId": "Entities.list", "summary": "Entities.list", "tags": ["Custom Entity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Entities are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Entities", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Entity"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EntityFitnesses/{id}": {"get": {"description": "Returns EntityFitness with given id", "operationId": "EntityFitnesses.get", "summary": "EntityFitnesses.get", "tags": ["Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of EntityFitness to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "EntityFitness data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EntityFitness"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes EntityFitness with given id", "operationId": "EntityFitnesses.delete", "summary": "EntityFitnesses.delete", "tags": ["Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of EntityFitness to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EntityFitness on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted EntityFitness", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies EntityFitness or EntityFitnesses with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of EntityFitness to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EntityFitness on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "EntityFitnesses.update", "summary": "EntityFitnesses.update", "tags": ["Opportunity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateEntityFitnessInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting EntityFitness", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EntityFitness"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EntityFitnesses": {"get": {"description": "Returns all defined EntityFitnesses", "operationId": "EntityFitnesses.list", "summary": "EntityFitnesses.list", "tags": ["Opportunity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted EntityFitnesses are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of EntityFitnesses", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/EntityFitness"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new EntityFitness", "operationId": "EntityFitnesses.create", "summary": "EntityFitnesses.create", "tags": ["Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EntityFitness on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EntityFitness", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createEntityFitnessInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created EntityFitness", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EntityFitness"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EntityFitnesses/batch-delete": {"post": {"description": "Removes EntityFitnesses with given list of ids", "operationId": "EntityFitnesses.batch_delete", "summary": "EntityFitnesses.batch_delete", "tags": ["Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EntityFitnesses on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EntityFitnesses. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EntityFitness to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted EntityFitness.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EntityFitnesses/batch-modify": {"post": {"description": "Create or update an batch of EntityFitnesses", "operationId": "EntityFitnesses.batch_create_or_update", "summary": "EntityFitnesses.batch_create_or_update", "tags": ["Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EntityFitnesses on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EntityFitnesses. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EntityFitness", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchEntityFitnessInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated EntityFitnesses", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EntityFitnesses/batch-restore": {"post": {"description": "Restores EntityFitnesses with given list of ids", "operationId": "EntityFitnesses.batch_restore", "summary": "EntityFitnesses.batch_restore", "tags": ["Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EntityFitnesses on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EntityFitnesses. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EntityFitness to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored EntityFitness.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EntityFitnessIndicators/{id}": {"get": {"description": "Returns EntityFitnessIndicator with given id", "operationId": "EntityFitnessIndicators.get", "summary": "EntityFitnessIndicators.get", "tags": ["Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of EntityFitnessIndicator to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "EntityFitnessIndicator data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EntityFitnessIndicator"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes EntityFitnessIndicator with given id", "operationId": "EntityFitnessIndicators.delete", "summary": "EntityFitnessIndicators.delete", "tags": ["Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of EntityFitnessIndicator to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EntityFitnessIndicator on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted EntityFitnessIndicator", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies EntityFitnessIndicator or EntityFitnessIndicators with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of EntityFitnessIndicator to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EntityFitnessIndicator on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "EntityFitnessIndicators.update", "summary": "EntityFitnessIndicators.update", "tags": ["Opportunity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateEntityFitnessIndicatorInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting EntityFitnessIndicator", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EntityFitnessIndicator"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EntityFitnessIndicators": {"get": {"description": "Returns all defined EntityFitnessIndicators", "operationId": "EntityFitnessIndicators.list", "summary": "EntityFitnessIndicators.list", "tags": ["Opportunity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted EntityFitnessIndicators are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of EntityFitnessIndicators", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/EntityFitnessIndicator"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new EntityFitnessIndicator", "operationId": "EntityFitnessIndicators.create", "summary": "EntityFitnessIndicators.create", "tags": ["Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EntityFitnessIndicator on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EntityFitnessIndicator", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createEntityFitnessIndicatorInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created EntityFitnessIndicator", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EntityFitnessIndicator"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EntityFitnessIndicators/batch-delete": {"post": {"description": "Removes EntityFitnessIndicators with given list of ids", "operationId": "EntityFitnessIndicators.batch_delete", "summary": "EntityFitnessIndicators.batch_delete", "tags": ["Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EntityFitnessIndicators on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EntityFitnessIndicators. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EntityFitnessIndicator to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted EntityFitnessIndicator.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EntityFitnessIndicators/batch-modify": {"post": {"description": "Create or update an batch of EntityFitnessIndicators", "operationId": "EntityFitnessIndicators.batch_create_or_update", "summary": "EntityFitnessIndicators.batch_create_or_update", "tags": ["Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EntityFitnessIndicators on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EntityFitnessIndicators. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EntityFitnessIndicator", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchEntityFitnessIndicatorInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated EntityFitnessIndicators", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EntityFitnessIndicators/batch-restore": {"post": {"description": "Restores EntityFitnessIndicators with given list of ids", "operationId": "EntityFitnessIndicators.batch_restore", "summary": "EntityFitnessIndicators.batch_restore", "tags": ["Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EntityFitnessIndicators on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EntityFitnessIndicators. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EntityFitnessIndicator to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored EntityFitnessIndicator.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EntityHealths/{id}": {"get": {"description": "Returns EntityHealth with given id", "operationId": "EntityHealths.get", "summary": "EntityHealths.get", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of EntityHealth to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "EntityHealth data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EntityHealth"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes EntityHealth with given id", "operationId": "EntityHealths.delete", "summary": "EntityHealths.delete", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of EntityHealth to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EntityHealth on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted EntityHealth", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies EntityHealth or EntityHealths with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of EntityHealth to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EntityHealth on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "EntityHealths.update", "summary": "EntityHealths.update", "tags": ["Account"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateEntityHealthInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting EntityHealth", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EntityHealth"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EntityHealths": {"get": {"description": "Returns all defined EntityHealths", "operationId": "EntityHealths.list", "summary": "EntityHealths.list", "tags": ["Account"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted EntityHealths are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of EntityHealths", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/EntityHealth"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new EntityHealth", "operationId": "EntityHealths.create", "summary": "EntityHealths.create", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EntityHealth on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EntityHealth", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createEntityHealthInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created EntityHealth", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EntityHealth"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EntityHealths/batch-delete": {"post": {"description": "Removes EntityHealths with given list of ids", "operationId": "EntityHealths.batch_delete", "summary": "EntityHealths.batch_delete", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EntityHealths on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EntityHealths. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EntityHealth to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted EntityHealth.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EntityHealths/batch-modify": {"post": {"description": "Create or update an batch of EntityHealths", "operationId": "EntityHealths.batch_create_or_update", "summary": "EntityHealths.batch_create_or_update", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EntityHealths on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EntityHealths. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EntityHealth", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchEntityHealthInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated EntityHealths", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EntityHealths/batch-restore": {"post": {"description": "Restores EntityHealths with given list of ids", "operationId": "EntityHealths.batch_restore", "summary": "EntityHealths.batch_restore", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EntityHealths on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EntityHealths. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EntityHealth to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored EntityHealth.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EntityScorings/{id}": {"get": {"description": "Returns EntityScoring with given id", "operationId": "EntityScorings.get", "summary": "EntityScorings.get", "tags": ["Lead"], "parameters": [{"name": "id", "in": "path", "description": "ID of EntityScoring to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "EntityScoring data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EntityScoring"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes EntityScoring with given id", "operationId": "EntityScorings.delete", "summary": "EntityScorings.delete", "tags": ["Lead"], "parameters": [{"name": "id", "in": "path", "description": "ID of EntityScoring to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EntityScoring on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted EntityScoring", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies EntityScoring or EntityScorings with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of EntityScoring to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EntityScoring on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "EntityScorings.update", "summary": "EntityScorings.update", "tags": ["Lead"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateEntityScoringInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting EntityScoring", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EntityScoring"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EntityScorings": {"get": {"description": "Returns all defined EntityScorings", "operationId": "EntityScorings.list", "summary": "EntityScorings.list", "tags": ["Lead"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted EntityScorings are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of EntityScorings", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/EntityScoring"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new EntityScoring", "operationId": "EntityScorings.create", "summary": "EntityScorings.create", "tags": ["Lead"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EntityScoring on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EntityScoring", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createEntityScoringInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created EntityScoring", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EntityScoring"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EntityScorings/batch-delete": {"post": {"description": "Removes EntityScorings with given list of ids", "operationId": "EntityScorings.batch_delete", "summary": "EntityScorings.batch_delete", "tags": ["Lead"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EntityScorings on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EntityScorings. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EntityScoring to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted EntityScoring.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EntityScorings/batch-modify": {"post": {"description": "Create or update an batch of EntityScorings", "operationId": "EntityScorings.batch_create_or_update", "summary": "EntityScorings.batch_create_or_update", "tags": ["Lead"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EntityScorings on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EntityScorings. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EntityScoring", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchEntityScoringInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated EntityScorings", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EntityScorings/batch-restore": {"post": {"description": "Restores EntityScorings with given list of ids", "operationId": "EntityScorings.batch_restore", "summary": "EntityScorings.batch_restore", "tags": ["Lead"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EntityScorings on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EntityScorings. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EntityScoring to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored EntityScoring.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EntitySettingses/{id}": {"get": {"description": "Returns EntitySettings with given id", "operationId": "EntitySettingses.get", "summary": "EntitySettingses.get", "tags": ["Custom Entity"], "parameters": [{"name": "id", "in": "path", "description": "ID of EntitySettings to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "EntitySettings data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EntitySettings"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes EntitySettings with given id", "operationId": "EntitySettingses.delete", "summary": "EntitySettingses.delete", "tags": ["Custom Entity"], "parameters": [{"name": "id", "in": "path", "description": "ID of EntitySettings to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EntitySettings on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted EntitySettings", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies EntitySettings or EntitySettingses with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of EntitySettings to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of EntitySettings on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "EntitySettingses.update", "summary": "EntitySettingses.update", "tags": ["Custom Entity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateEntitySettingsInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting EntitySettings", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EntitySettings"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EntitySettingses": {"get": {"description": "Returns all defined EntitySettingses", "operationId": "EntitySettingses.list", "summary": "EntitySettingses.list", "tags": ["Custom Entity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted EntitySettingses are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of EntitySettingses", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/EntitySettings"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new EntitySettings", "operationId": "EntitySettingses.create", "summary": "EntitySettingses.create", "tags": ["Custom Entity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EntitySettings on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EntitySettings", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createEntitySettingsInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created EntitySettings", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/EntitySettings"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EntitySettingses/batch-delete": {"post": {"description": "Removes EntitySettingses with given list of ids", "operationId": "EntitySettingses.batch_delete", "summary": "EntitySettingses.batch_delete", "tags": ["Custom Entity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EntitySettingses on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EntitySettingses. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EntitySettings to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted EntitySettings.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EntitySettingses/batch-modify": {"post": {"description": "Create or update an batch of EntitySettingses", "operationId": "EntitySettingses.batch_create_or_update", "summary": "EntitySettingses.batch_create_or_update", "tags": ["Custom Entity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EntitySettingses on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EntitySettingses. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new EntitySettings", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchEntitySettingsInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated EntitySettingses", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/EntitySettingses/batch-restore": {"post": {"description": "Restores EntitySettingses with given list of ids", "operationId": "EntitySettingses.batch_restore", "summary": "EntitySettingses.batch_restore", "tags": ["Custom Entity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of EntitySettingses on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for EntitySettingses. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity EntitySettings to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored EntitySettings.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Fields/{id}": {"get": {"description": "Returns Field with given id", "operationId": "Fields.get", "summary": "Fields.get", "tags": ["Field"], "parameters": [{"name": "id", "in": "path", "description": "ID of Field to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Field data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Field"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Field with given id", "operationId": "Fields.delete", "summary": "Fields.delete", "tags": ["Field"], "parameters": [{"name": "id", "in": "path", "description": "ID of Field to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Field on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Field", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Field or Fields with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Field to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Field on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Fields.update", "summary": "Fields.update", "tags": ["Field"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateFieldInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Field", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Field"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Fields": {"get": {"description": "Returns all defined Fields", "operationId": "Fields.list", "summary": "Fields.list", "tags": ["Field"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Fields are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Fields", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Field"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Field", "operationId": "Fields.create", "summary": "Fields.create", "tags": ["Field"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Field on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Field", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createFieldInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Field", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Field"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Fields/batch-restore": {"post": {"description": "Restores Fields with given list of ids", "operationId": "Fields.batch_restore", "summary": "Fields.batch_restore", "tags": ["Field"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Fields on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Fields. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Field to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Field.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FieldMappings/{id}": {"get": {"description": "Returns FieldMapping with given id", "operationId": "FieldMappings.get", "summary": "FieldMappings.get", "tags": ["Field"], "parameters": [{"name": "id", "in": "path", "description": "ID of FieldMapping to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "FieldMapping data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/FieldMapping"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes FieldMapping with given id", "operationId": "FieldMappings.delete", "summary": "FieldMappings.delete", "tags": ["Field"], "parameters": [{"name": "id", "in": "path", "description": "ID of FieldMapping to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of FieldMapping on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted FieldMapping", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies FieldMapping or FieldMappings with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of FieldMapping to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of FieldMapping on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "FieldMappings.update", "summary": "FieldMappings.update", "tags": ["Field"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateFieldMappingInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting FieldMapping", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/FieldMapping"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FieldMappings": {"get": {"description": "Returns all defined FieldMappings", "operationId": "FieldMappings.list", "summary": "FieldMappings.list", "tags": ["Field"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted FieldMappings are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of FieldMappings", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/FieldMapping"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new FieldMapping", "operationId": "FieldMappings.create", "summary": "FieldMappings.create", "tags": ["Field"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of FieldMapping on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new FieldMapping", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createFieldMappingInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created FieldMapping", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/FieldMapping"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FieldMappings/batch-delete": {"post": {"description": "Removes FieldMappings with given list of ids", "operationId": "FieldMappings.batch_delete", "summary": "FieldMappings.batch_delete", "tags": ["Field"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of FieldMappings on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for FieldMappings. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity FieldMapping to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted FieldMapping.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FieldMappings/batch-modify": {"post": {"description": "Create or update an batch of FieldMappings", "operationId": "FieldMappings.batch_create_or_update", "summary": "FieldMappings.batch_create_or_update", "tags": ["Field"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of FieldMappings on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for FieldMappings. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new FieldMapping", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchFieldMappingInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated FieldMappings", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FieldMappings/batch-restore": {"post": {"description": "Restores FieldMappings with given list of ids", "operationId": "FieldMappings.batch_restore", "summary": "FieldMappings.batch_restore", "tags": ["Field"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of FieldMappings on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for FieldMappings. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity FieldMapping to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored FieldMapping.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FieldPermissions/{id}": {"get": {"description": "Returns FieldPermission with given id", "operationId": "FieldPermissions.get", "summary": "FieldPermissions.get", "tags": ["Field"], "parameters": [{"name": "id", "in": "path", "description": "ID of FieldPermission to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "FieldPermission data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/FieldPermission"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes FieldPermission with given id", "operationId": "FieldPermissions.delete", "summary": "FieldPermissions.delete", "tags": ["Field"], "parameters": [{"name": "id", "in": "path", "description": "ID of FieldPermission to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of FieldPermission on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted FieldPermission", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies FieldPermission or FieldPermissions with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of FieldPermission to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of FieldPermission on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "FieldPermissions.update", "summary": "FieldPermissions.update", "tags": ["Field"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateFieldPermissionInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting FieldPermission", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/FieldPermission"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FieldPermissions": {"get": {"description": "Returns all defined FieldPermissions", "operationId": "FieldPermissions.list", "summary": "FieldPermissions.list", "tags": ["Field"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted FieldPermissions are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of FieldPermissions", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/FieldPermission"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new FieldPermission", "operationId": "FieldPermissions.create", "summary": "FieldPermissions.create", "tags": ["Field"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of FieldPermission on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new FieldPermission", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createFieldPermissionInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created FieldPermission", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/FieldPermission"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FieldPermissions/batch-delete": {"post": {"description": "Removes FieldPermissions with given list of ids", "operationId": "FieldPermissions.batch_delete", "summary": "FieldPermissions.batch_delete", "tags": ["Field"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of FieldPermissions on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for FieldPermissions. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity FieldPermission to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted FieldPermission.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FieldPermissions/batch-modify": {"post": {"description": "Create or update an batch of FieldPermissions", "operationId": "FieldPermissions.batch_create_or_update", "summary": "FieldPermissions.batch_create_or_update", "tags": ["Field"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of FieldPermissions on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for FieldPermissions. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new FieldPermission", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchFieldPermissionInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated FieldPermissions", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FieldPermissions/batch-restore": {"post": {"description": "Restores FieldPermissions with given list of ids", "operationId": "FieldPermissions.batch_restore", "summary": "FieldPermissions.batch_restore", "tags": ["Field"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of FieldPermissions on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for FieldPermissions. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity FieldPermission to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored FieldPermission.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FieldSequences/{id}": {"get": {"description": "Returns FieldSequence with given id", "operationId": "FieldSequences.get", "summary": "FieldSequences.get", "tags": ["Field"], "parameters": [{"name": "id", "in": "path", "description": "ID of FieldSequence to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "FieldSequence data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/FieldSequence"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FieldSequences": {"get": {"description": "Returns all defined FieldSequences", "operationId": "FieldSequences.list", "summary": "FieldSequences.list", "tags": ["Field"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted FieldSequences are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of FieldSequences", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/FieldSequence"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Forecasts/{id}": {"get": {"description": "Returns Forecast with given id", "operationId": "Forecasts.get", "summary": "Forecasts.get", "tags": ["Forecast"], "parameters": [{"name": "id", "in": "path", "description": "ID of Forecast to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Forecast data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Forecast"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Forecast with given id", "operationId": "Forecasts.delete", "summary": "Forecasts.delete", "tags": ["Forecast"], "parameters": [{"name": "id", "in": "path", "description": "ID of Forecast to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Forecast on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Forecast", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Forecast or Forecasts with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Forecast to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Forecast on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Forecasts.update", "summary": "Forecasts.update", "tags": ["Forecast"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateForecastInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Forecast", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Forecast"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Forecasts": {"get": {"description": "Returns all defined Forecasts", "operationId": "Forecasts.list", "summary": "Forecasts.list", "tags": ["Forecast"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Forecasts are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Forecasts", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Forecast"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Forecast", "operationId": "Forecasts.create", "summary": "Forecasts.create", "tags": ["Forecast"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Forecast on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Forecast", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createForecastInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Forecast", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Forecast"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Forecasts/batch-delete": {"post": {"description": "Removes Forecasts with given list of ids", "operationId": "Forecasts.batch_delete", "summary": "Forecasts.batch_delete", "tags": ["Forecast"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Forecasts on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Forecasts. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Forecast to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Forecast.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Forecasts/batch-modify": {"post": {"description": "Create or update an batch of Forecasts", "operationId": "Forecasts.batch_create_or_update", "summary": "Forecasts.batch_create_or_update", "tags": ["Forecast"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Forecasts on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Forecasts. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Forecast", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchForecastInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Forecasts", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Forecasts/batch-restore": {"post": {"description": "Restores Forecasts with given list of ids", "operationId": "Forecasts.batch_restore", "summary": "Forecasts.batch_restore", "tags": ["Forecast"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Forecasts on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Forecasts. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Forecast to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Forecast.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FormViews/{id}": {"get": {"description": "Returns FormView with given id", "operationId": "FormViews.get", "summary": "FormViews.get", "tags": ["Form"], "parameters": [{"name": "id", "in": "path", "description": "ID of FormView to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "FormView data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/FormView"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes FormView with given id", "operationId": "FormViews.delete", "summary": "FormViews.delete", "tags": ["Form"], "parameters": [{"name": "id", "in": "path", "description": "ID of FormView to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of FormView on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted FormView", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies FormView or FormViews with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of FormView to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of FormView on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "FormViews.update", "summary": "FormViews.update", "tags": ["Form"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateFormViewInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting FormView", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/FormView"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FormViews": {"get": {"description": "Returns all defined FormViews", "operationId": "FormViews.list", "summary": "FormViews.list", "tags": ["Form"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted FormViews are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of FormViews", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/FormView"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new FormView", "operationId": "FormViews.create", "summary": "FormViews.create", "tags": ["Form"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of FormView on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new FormView", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createFormViewInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created FormView", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/FormView"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FormViews/batch-delete": {"post": {"description": "Removes FormViews with given list of ids", "operationId": "FormViews.batch_delete", "summary": "FormViews.batch_delete", "tags": ["Form"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of FormViews on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for FormViews. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity FormView to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted FormView.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FormViews/batch-modify": {"post": {"description": "Create or update an batch of FormViews", "operationId": "FormViews.batch_create_or_update", "summary": "FormViews.batch_create_or_update", "tags": ["Form"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of FormViews on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for FormViews. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new FormView", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchFormViewInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated FormViews", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FormViews/batch-restore": {"post": {"description": "Restores FormViews with given list of ids", "operationId": "FormViews.batch_restore", "summary": "FormViews.batch_restore", "tags": ["Form"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of FormViews on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for FormViews. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity FormView to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored FormView.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FormViewSharingClientRelations/{id}": {"get": {"description": "Returns FormViewSharingClientRelation with given id", "operationId": "FormViewSharingClientRelations.get", "summary": "FormViewSharingClientRelations.get", "tags": ["Form"], "parameters": [{"name": "id", "in": "path", "description": "ID of FormViewSharingClientRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "FormViewSharingClientRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/FormViewSharingClientRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes FormViewSharingClientRelation with given id", "operationId": "FormViewSharingClientRelations.delete", "summary": "FormViewSharingClientRelations.delete", "tags": ["Form"], "parameters": [{"name": "id", "in": "path", "description": "ID of FormViewSharingClientRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of FormViewSharingClientRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted FormViewSharingClientRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies FormViewSharingClientRelation or FormViewSharingClientRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of FormViewSharingClientRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of FormViewSharingClientRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "FormViewSharingClientRelations.update", "summary": "FormViewSharingClientRelations.update", "tags": ["Form"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateFormViewSharingClientRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting FormViewSharingClientRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/FormViewSharingClientRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FormViewSharingClientRelations": {"get": {"description": "Returns all defined FormViewSharingClientRelations", "operationId": "FormViewSharingClientRelations.list", "summary": "FormViewSharingClientRelations.list", "tags": ["Form"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted FormViewSharingClientRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of FormViewSharingClientRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/FormViewSharingClientRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new FormViewSharingClientRelation", "operationId": "FormViewSharingClientRelations.create", "summary": "FormViewSharingClientRelations.create", "tags": ["Form"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of FormViewSharingClientRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new FormViewSharingClientRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createFormViewSharingClientRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created FormViewSharingClientRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/FormViewSharingClientRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FormViewSharingClientRelations/batch-delete": {"post": {"description": "Removes FormViewSharingClientRelations with given list of ids", "operationId": "FormViewSharingClientRelations.batch_delete", "summary": "FormViewSharingClientRelations.batch_delete", "tags": ["Form"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of FormViewSharingClientRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for FormViewSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity FormViewSharingClientRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted FormViewSharingClientRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FormViewSharingClientRelations/batch-modify": {"post": {"description": "Create or update an batch of FormViewSharingClientRelations", "operationId": "FormViewSharingClientRelations.batch_create_or_update", "summary": "FormViewSharingClientRelations.batch_create_or_update", "tags": ["Form"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of FormViewSharingClientRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for FormViewSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new FormViewSharingClientRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchFormViewSharingClientRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated FormViewSharingClientRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FormViewSharingClientRelations/batch-restore": {"post": {"description": "Restores FormViewSharingClientRelations with given list of ids", "operationId": "FormViewSharingClientRelations.batch_restore", "summary": "FormViewSharingClientRelations.batch_restore", "tags": ["Form"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of FormViewSharingClientRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for FormViewSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity FormViewSharingClientRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored FormViewSharingClientRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FormViewSharingSalesUnitRelations/{id}": {"get": {"description": "Returns FormViewSharingSalesUnitRelation with given id", "operationId": "FormViewSharingSalesUnitRelations.get", "summary": "FormViewSharingSalesUnitRelations.get", "tags": ["Form"], "parameters": [{"name": "id", "in": "path", "description": "ID of FormViewSharingSalesUnitRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "FormViewSharingSalesUnitRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/FormViewSharingSalesUnitRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes FormViewSharingSalesUnitRelation with given id", "operationId": "FormViewSharingSalesUnitRelations.delete", "summary": "FormViewSharingSalesUnitRelations.delete", "tags": ["Form"], "parameters": [{"name": "id", "in": "path", "description": "ID of FormViewSharingSalesUnitRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of FormViewSharingSalesUnitRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted FormViewSharingSalesUnitRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies FormViewSharingSalesUnitRelation or FormViewSharingSalesUnitRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of FormViewSharingSalesUnitRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of FormViewSharingSalesUnitRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "FormViewSharingSalesUnitRelations.update", "summary": "FormViewSharingSalesUnitRelations.update", "tags": ["Form"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateFormViewSharingSalesUnitRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting FormViewSharingSalesUnitRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/FormViewSharingSalesUnitRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FormViewSharingSalesUnitRelations": {"get": {"description": "Returns all defined FormViewSharingSalesUnitRelations", "operationId": "FormViewSharingSalesUnitRelations.list", "summary": "FormViewSharingSalesUnitRelations.list", "tags": ["Form"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted FormViewSharingSalesUnitRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of FormViewSharingSalesUnitRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/FormViewSharingSalesUnitRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new FormViewSharingSalesUnitRelation", "operationId": "FormViewSharingSalesUnitRelations.create", "summary": "FormViewSharingSalesUnitRelations.create", "tags": ["Form"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of FormViewSharingSalesUnitRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new FormViewSharingSalesUnitRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createFormViewSharingSalesUnitRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created FormViewSharingSalesUnitRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/FormViewSharingSalesUnitRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FormViewSharingSalesUnitRelations/batch-delete": {"post": {"description": "Removes FormViewSharingSalesUnitRelations with given list of ids", "operationId": "FormViewSharingSalesUnitRelations.batch_delete", "summary": "FormViewSharingSalesUnitRelations.batch_delete", "tags": ["Form"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of FormViewSharingSalesUnitRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for FormViewSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity FormViewSharingSalesUnitRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted FormViewSharingSalesUnitRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FormViewSharingSalesUnitRelations/batch-modify": {"post": {"description": "Create or update an batch of FormViewSharingSalesUnitRelations", "operationId": "FormViewSharingSalesUnitRelations.batch_create_or_update", "summary": "FormViewSharingSalesUnitRelations.batch_create_or_update", "tags": ["Form"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of FormViewSharingSalesUnitRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for FormViewSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new FormViewSharingSalesUnitRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchFormViewSharingSalesUnitRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated FormViewSharingSalesUnitRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/FormViewSharingSalesUnitRelations/batch-restore": {"post": {"description": "Restores FormViewSharingSalesUnitRelations with given list of ids", "operationId": "FormViewSharingSalesUnitRelations.batch_restore", "summary": "FormViewSharingSalesUnitRelations.batch_restore", "tags": ["Form"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of FormViewSharingSalesUnitRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for FormViewSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity FormViewSharingSalesUnitRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored FormViewSharingSalesUnitRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/GhostContacts/{id}": {"get": {"description": "Returns GhostContact with given id", "operationId": "GhostContacts.get", "summary": "GhostContacts.get", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of GhostContact to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "GhostContact data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/GhostContact"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes GhostContact with given id", "operationId": "GhostContacts.delete", "summary": "GhostContacts.delete", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of GhostContact to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of GhostContact on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted GhostContact", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies GhostContact or GhostContacts with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of GhostContact to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of GhostContact on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "GhostContacts.update", "summary": "GhostContacts.update", "tags": ["Contact"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateGhostContactInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting GhostContact", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/GhostContact"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/GhostContacts": {"get": {"description": "Returns all defined GhostContacts", "operationId": "GhostContacts.list", "summary": "GhostContacts.list", "tags": ["Contact"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted GhostContacts are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of GhostContacts", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/GhostContact"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new GhostContact", "operationId": "GhostContacts.create", "summary": "GhostContacts.create", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of GhostContact on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new GhostContact", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createGhostContactInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created GhostContact", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/GhostContact"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/GhostContacts/batch-delete": {"post": {"description": "Removes GhostContacts with given list of ids", "operationId": "GhostContacts.batch_delete", "summary": "GhostContacts.batch_delete", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of GhostContacts on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for GhostContacts. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity GhostContact to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted GhostContact.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/GhostContacts/batch-modify": {"post": {"description": "Create or update an batch of GhostContacts", "operationId": "GhostContacts.batch_create_or_update", "summary": "GhostContacts.batch_create_or_update", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of GhostContacts on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for GhostContacts. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new GhostContact", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchGhostContactInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated GhostContacts", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/GhostContacts/batch-restore": {"post": {"description": "Restores GhostContacts with given list of ids", "operationId": "GhostContacts.batch_restore", "summary": "GhostContacts.batch_restore", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of GhostContacts on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for GhostContacts. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity GhostContact to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored GhostContact.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/GhostContactAccountAccountRoleRelations/{id}": {"get": {"description": "Returns GhostContactAccountAccountRoleRelation with given id", "operationId": "GhostContactAccountAccountRoleRelations.get", "summary": "GhostContactAccountAccountRoleRelations.get", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of GhostContactAccountAccountRoleRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "GhostContactAccountAccountRoleRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/GhostContactAccountAccountRoleRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes GhostContactAccountAccountRoleRelation with given id", "operationId": "GhostContactAccountAccountRoleRelations.delete", "summary": "GhostContactAccountAccountRoleRelations.delete", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of GhostContactAccountAccountRoleRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of GhostContactAccountAccountRoleRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted GhostContactAccountAccountRoleRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies GhostContactAccountAccountRoleRelation or GhostContactAccountAccountRoleRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of GhostContactAccountAccountRoleRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of GhostContactAccountAccountRoleRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "GhostContactAccountAccountRoleRelations.update", "summary": "GhostContactAccountAccountRoleRelations.update", "tags": ["Contact"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateGhostContactAccountAccountRoleRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting GhostContactAccountAccountRoleRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/GhostContactAccountAccountRoleRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/GhostContactAccountAccountRoleRelations": {"get": {"description": "Returns all defined GhostContactAccountAccountRoleRelations", "operationId": "GhostContactAccountAccountRoleRelations.list", "summary": "GhostContactAccountAccountRoleRelations.list", "tags": ["Contact"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted GhostContactAccountAccountRoleRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of GhostContactAccountAccountRoleRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/GhostContactAccountAccountRoleRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new GhostContactAccountAccountRoleRelation", "operationId": "GhostContactAccountAccountRoleRelations.create", "summary": "GhostContactAccountAccountRoleRelations.create", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of GhostContactAccountAccountRoleRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new GhostContactAccountAccountRoleRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createGhostContactAccountAccountRoleRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created GhostContactAccountAccountRoleRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/GhostContactAccountAccountRoleRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/GhostContactAccountAccountRoleRelations/batch-delete": {"post": {"description": "Removes GhostContactAccountAccountRoleRelations with given list of ids", "operationId": "GhostContactAccountAccountRoleRelations.batch_delete", "summary": "GhostContactAccountAccountRoleRelations.batch_delete", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of GhostContactAccountAccountRoleRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for GhostContactAccountAccountRoleRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity GhostContactAccountAccountRoleRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted GhostContactAccountAccountRoleRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/GhostContactAccountAccountRoleRelations/batch-modify": {"post": {"description": "Create or update an batch of GhostContactAccountAccountRoleRelations", "operationId": "GhostContactAccountAccountRoleRelations.batch_create_or_update", "summary": "GhostContactAccountAccountRoleRelations.batch_create_or_update", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of GhostContactAccountAccountRoleRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for GhostContactAccountAccountRoleRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new GhostContactAccountAccountRoleRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchGhostContactAccountAccountRoleRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated GhostContactAccountAccountRoleRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/GhostContactAccountAccountRoleRelations/batch-restore": {"post": {"description": "Restores GhostContactAccountAccountRoleRelations with given list of ids", "operationId": "GhostContactAccountAccountRoleRelations.batch_restore", "summary": "GhostContactAccountAccountRoleRelations.batch_restore", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of GhostContactAccountAccountRoleRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for GhostContactAccountAccountRoleRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity GhostContactAccountAccountRoleRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored GhostContactAccountAccountRoleRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/GhostContactAccountRelations/{id}": {"get": {"description": "Returns GhostContactAccountRelation with given id", "operationId": "GhostContactAccountRelations.get", "summary": "GhostContactAccountRelations.get", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of GhostContactAccountRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "GhostContactAccountRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/GhostContactAccountRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes GhostContactAccountRelation with given id", "operationId": "GhostContactAccountRelations.delete", "summary": "GhostContactAccountRelations.delete", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of GhostContactAccountRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of GhostContactAccountRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted GhostContactAccountRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies GhostContactAccountRelation or GhostContactAccountRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of GhostContactAccountRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of GhostContactAccountRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "GhostContactAccountRelations.update", "summary": "GhostContactAccountRelations.update", "tags": ["Contact"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateGhostContactAccountRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting GhostContactAccountRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/GhostContactAccountRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/GhostContactAccountRelations": {"get": {"description": "Returns all defined GhostContactAccountRelations", "operationId": "GhostContactAccountRelations.list", "summary": "GhostContactAccountRelations.list", "tags": ["Contact"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted GhostContactAccountRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of GhostContactAccountRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/GhostContactAccountRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new GhostContactAccountRelation", "operationId": "GhostContactAccountRelations.create", "summary": "GhostContactAccountRelations.create", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of GhostContactAccountRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new GhostContactAccountRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createGhostContactAccountRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created GhostContactAccountRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/GhostContactAccountRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/GhostContactAccountRelations/batch-delete": {"post": {"description": "Removes GhostContactAccountRelations with given list of ids", "operationId": "GhostContactAccountRelations.batch_delete", "summary": "GhostContactAccountRelations.batch_delete", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of GhostContactAccountRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for GhostContactAccountRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity GhostContactAccountRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted GhostContactAccountRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/GhostContactAccountRelations/batch-modify": {"post": {"description": "Create or update an batch of GhostContactAccountRelations", "operationId": "GhostContactAccountRelations.batch_create_or_update", "summary": "GhostContactAccountRelations.batch_create_or_update", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of GhostContactAccountRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for GhostContactAccountRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new GhostContactAccountRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchGhostContactAccountRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated GhostContactAccountRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/GhostContactAccountRelations/batch-restore": {"post": {"description": "Restores GhostContactAccountRelations with given list of ids", "operationId": "GhostContactAccountRelations.batch_restore", "summary": "GhostContactAccountRelations.batch_restore", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of GhostContactAccountRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for GhostContactAccountRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity GhostContactAccountRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored GhostContactAccountRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/GhostLeadOpptyContactRelations/{id}": {"get": {"description": "Returns GhostLeadOpptyContactRelation with given id", "operationId": "GhostLeadOpptyContactRelations.get", "summary": "GhostLeadOpptyContactRelations.get", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of GhostLeadOpptyContactRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "GhostLeadOpptyContactRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/GhostLeadOpptyContactRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes GhostLeadOpptyContactRelation with given id", "operationId": "GhostLeadOpptyContactRelations.delete", "summary": "GhostLeadOpptyContactRelations.delete", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of GhostLeadOpptyContactRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of GhostLeadOpptyContactRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted GhostLeadOpptyContactRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies GhostLeadOpptyContactRelation or GhostLeadOpptyContactRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of GhostLeadOpptyContactRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of GhostLeadOpptyContactRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "GhostLeadOpptyContactRelations.update", "summary": "GhostLeadOpptyContactRelations.update", "tags": ["Contact"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateGhostLeadOpptyContactRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting GhostLeadOpptyContactRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/GhostLeadOpptyContactRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/GhostLeadOpptyContactRelations": {"get": {"description": "Returns all defined GhostLeadOpptyContactRelations", "operationId": "GhostLeadOpptyContactRelations.list", "summary": "GhostLeadOpptyContactRelations.list", "tags": ["Contact"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted GhostLeadOpptyContactRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of GhostLeadOpptyContactRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/GhostLeadOpptyContactRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new GhostLeadOpptyContactRelation", "operationId": "GhostLeadOpptyContactRelations.create", "summary": "GhostLeadOpptyContactRelations.create", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of GhostLeadOpptyContactRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new GhostLeadOpptyContactRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createGhostLeadOpptyContactRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created GhostLeadOpptyContactRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/GhostLeadOpptyContactRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/GhostLeadOpptyContactRelations/batch-delete": {"post": {"description": "Removes GhostLeadOpptyContactRelations with given list of ids", "operationId": "GhostLeadOpptyContactRelations.batch_delete", "summary": "GhostLeadOpptyContactRelations.batch_delete", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of GhostLeadOpptyContactRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for GhostLeadOpptyContactRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity GhostLeadOpptyContactRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted GhostLeadOpptyContactRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/GhostLeadOpptyContactRelations/batch-modify": {"post": {"description": "Create or update an batch of GhostLeadOpptyContactRelations", "operationId": "GhostLeadOpptyContactRelations.batch_create_or_update", "summary": "GhostLeadOpptyContactRelations.batch_create_or_update", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of GhostLeadOpptyContactRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for GhostLeadOpptyContactRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new GhostLeadOpptyContactRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchGhostLeadOpptyContactRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated GhostLeadOpptyContactRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/GhostLeadOpptyContactRelations/batch-restore": {"post": {"description": "Restores GhostLeadOpptyContactRelations with given list of ids", "operationId": "GhostLeadOpptyContactRelations.batch_restore", "summary": "GhostLeadOpptyContactRelations.batch_restore", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of GhostLeadOpptyContactRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for GhostLeadOpptyContactRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity GhostLeadOpptyContactRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored GhostLeadOpptyContactRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/GhostLeadOpptyContactSalesRoleRelations/{id}": {"get": {"description": "Returns GhostLeadOpptyContactSalesRoleRelation with given id", "operationId": "GhostLeadOpptyContactSalesRoleRelations.get", "summary": "GhostLeadOpptyContactSalesRoleRelations.get", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of GhostLeadOpptyContactSalesRoleRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "GhostLeadOpptyContactSalesRoleRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/GhostLeadOpptyContactSalesRoleRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes GhostLeadOpptyContactSalesRoleRelation with given id", "operationId": "GhostLeadOpptyContactSalesRoleRelations.delete", "summary": "GhostLeadOpptyContactSalesRoleRelations.delete", "tags": ["Contact"], "parameters": [{"name": "id", "in": "path", "description": "ID of GhostLeadOpptyContactSalesRoleRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of GhostLeadOpptyContactSalesRoleRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted GhostLeadOpptyContactSalesRoleRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies GhostLeadOpptyContactSalesRoleRelation or GhostLeadOpptyContactSalesRoleRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of GhostLeadOpptyContactSalesRoleRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of GhostLeadOpptyContactSalesRoleRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "GhostLeadOpptyContactSalesRoleRelations.update", "summary": "GhostLeadOpptyContactSalesRoleRelations.update", "tags": ["Contact"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateGhostLeadOpptyContactSalesRoleRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting GhostLeadOpptyContactSalesRoleRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/GhostLeadOpptyContactSalesRoleRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/GhostLeadOpptyContactSalesRoleRelations": {"get": {"description": "Returns all defined GhostLeadOpptyContactSalesRoleRelations", "operationId": "GhostLeadOpptyContactSalesRoleRelations.list", "summary": "GhostLeadOpptyContactSalesRoleRelations.list", "tags": ["Contact"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted GhostLeadOpptyContactSalesRoleRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of GhostLeadOpptyContactSalesRoleRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/GhostLeadOpptyContactSalesRoleRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new GhostLeadOpptyContactSalesRoleRelation", "operationId": "GhostLeadOpptyContactSalesRoleRelations.create", "summary": "GhostLeadOpptyContactSalesRoleRelations.create", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of GhostLeadOpptyContactSalesRoleRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new GhostLeadOpptyContactSalesRoleRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createGhostLeadOpptyContactSalesRoleRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created GhostLeadOpptyContactSalesRoleRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/GhostLeadOpptyContactSalesRoleRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/GhostLeadOpptyContactSalesRoleRelations/batch-delete": {"post": {"description": "Removes GhostLeadOpptyContactSalesRoleRelations with given list of ids", "operationId": "GhostLeadOpptyContactSalesRoleRelations.batch_delete", "summary": "GhostLeadOpptyContactSalesRoleRelations.batch_delete", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of GhostLeadOpptyContactSalesRoleRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for GhostLeadOpptyContactSalesRoleRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity GhostLeadOpptyContactSalesRoleRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted GhostLeadOpptyContactSalesRoleRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/GhostLeadOpptyContactSalesRoleRelations/batch-modify": {"post": {"description": "Create or update an batch of GhostLeadOpptyContactSalesRoleRelations", "operationId": "GhostLeadOpptyContactSalesRoleRelations.batch_create_or_update", "summary": "GhostLeadOpptyContactSalesRoleRelations.batch_create_or_update", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of GhostLeadOpptyContactSalesRoleRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for GhostLeadOpptyContactSalesRoleRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new GhostLeadOpptyContactSalesRoleRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchGhostLeadOpptyContactSalesRoleRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated GhostLeadOpptyContactSalesRoleRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/GhostLeadOpptyContactSalesRoleRelations/batch-restore": {"post": {"description": "Restores GhostLeadOpptyContactSalesRoleRelations with given list of ids", "operationId": "GhostLeadOpptyContactSalesRoleRelations.batch_restore", "summary": "GhostLeadOpptyContactSalesRoleRelations.batch_restore", "tags": ["Contact"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of GhostLeadOpptyContactSalesRoleRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for GhostLeadOpptyContactSalesRoleRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity GhostLeadOpptyContactSalesRoleRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored GhostLeadOpptyContactSalesRoleRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ImportMappingMasks/{id}": {"get": {"description": "Returns ImportMappingMask with given id", "operationId": "ImportMappingMasks.get", "summary": "ImportMappingMasks.get", "tags": ["Import"], "parameters": [{"name": "id", "in": "path", "description": "ID of ImportMappingMask to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ImportMappingMask data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ImportMappingMask"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ImportMappingMask with given id", "operationId": "ImportMappingMasks.delete", "summary": "ImportMappingMasks.delete", "tags": ["Import"], "parameters": [{"name": "id", "in": "path", "description": "ID of ImportMappingMask to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ImportMappingMask on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ImportMappingMask", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ImportMappingMask or ImportMappingMasks with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ImportMappingMask to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ImportMappingMask on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ImportMappingMasks.update", "summary": "ImportMappingMasks.update", "tags": ["Import"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateImportMappingMaskInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ImportMappingMask", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ImportMappingMask"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ImportMappingMasks": {"get": {"description": "Returns all defined ImportMappingMasks", "operationId": "ImportMappingMasks.list", "summary": "ImportMappingMasks.list", "tags": ["Import"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ImportMappingMasks are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ImportMappingMasks", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ImportMappingMask"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ImportMappingMask", "operationId": "ImportMappingMasks.create", "summary": "ImportMappingMasks.create", "tags": ["Import"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ImportMappingMask on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ImportMappingMask", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createImportMappingMaskInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ImportMappingMask", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ImportMappingMask"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ImportMappingMasks/batch-delete": {"post": {"description": "Removes ImportMappingMasks with given list of ids", "operationId": "ImportMappingMasks.batch_delete", "summary": "ImportMappingMasks.batch_delete", "tags": ["Import"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ImportMappingMasks on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ImportMappingMasks. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ImportMappingMask to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ImportMappingMask.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ImportMappingMasks/batch-modify": {"post": {"description": "Create or update an batch of ImportMappingMasks", "operationId": "ImportMappingMasks.batch_create_or_update", "summary": "ImportMappingMasks.batch_create_or_update", "tags": ["Import"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ImportMappingMasks on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ImportMappingMasks. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ImportMappingMask", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchImportMappingMaskInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ImportMappingMasks", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ImportMappingMasks/batch-restore": {"post": {"description": "Restores ImportMappingMasks with given list of ids", "operationId": "ImportMappingMasks.batch_restore", "summary": "ImportMappingMasks.batch_restore", "tags": ["Import"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ImportMappingMasks on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ImportMappingMasks. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ImportMappingMask to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ImportMappingMask.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/InterfacePreviews/{id}": {"get": {"description": "Returns InterfacePreview with given id", "operationId": "InterfacePreviews.get", "summary": "InterfacePreviews.get", "tags": ["Interface"], "parameters": [{"name": "id", "in": "path", "description": "ID of InterfacePreview to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "InterfacePreview data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/InterfacePreview"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes InterfacePreview with given id", "operationId": "InterfacePreviews.delete", "summary": "InterfacePreviews.delete", "tags": ["Interface"], "parameters": [{"name": "id", "in": "path", "description": "ID of InterfacePreview to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of InterfacePreview on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted InterfacePreview", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies InterfacePreview or InterfacePreviews with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of InterfacePreview to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of InterfacePreview on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "InterfacePreviews.update", "summary": "InterfacePreviews.update", "tags": ["Interface"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateInterfacePreviewInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting InterfacePreview", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/InterfacePreview"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/InterfacePreviews": {"get": {"description": "Returns all defined InterfacePreviews", "operationId": "InterfacePreviews.list", "summary": "InterfacePreviews.list", "tags": ["Interface"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted InterfacePreviews are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of InterfacePreviews", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/InterfacePreview"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new InterfacePreview", "operationId": "InterfacePreviews.create", "summary": "InterfacePreviews.create", "tags": ["Interface"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of InterfacePreview on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new InterfacePreview", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createInterfacePreviewInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created InterfacePreview", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/InterfacePreview"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/InterfacePreviews/batch-delete": {"post": {"description": "Removes InterfacePreviews with given list of ids", "operationId": "InterfacePreviews.batch_delete", "summary": "InterfacePreviews.batch_delete", "tags": ["Interface"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of InterfacePreviews on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for InterfacePreviews. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity InterfacePreview to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted InterfacePreview.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/InterfacePreviews/batch-modify": {"post": {"description": "Create or update an batch of InterfacePreviews", "operationId": "InterfacePreviews.batch_create_or_update", "summary": "InterfacePreviews.batch_create_or_update", "tags": ["Interface"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of InterfacePreviews on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for InterfacePreviews. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new InterfacePreview", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchInterfacePreviewInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated InterfacePreviews", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/InterfacePreviews/batch-restore": {"post": {"description": "Restores InterfacePreviews with given list of ids", "operationId": "InterfacePreviews.batch_restore", "summary": "InterfacePreviews.batch_restore", "tags": ["Interface"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of InterfacePreviews on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for InterfacePreviews. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity InterfacePreview to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored InterfacePreview.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Leads/{id}": {"get": {"description": "Returns Lead with given id", "operationId": "Leads.get", "summary": "Leads.get", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of Lead to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Lead data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Lead"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Lead with given id", "operationId": "Leads.delete", "summary": "Leads.delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of Lead to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Lead on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Lead", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Lead or Leads with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Lead to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Lead on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Leads.update", "summary": "Leads.update", "tags": ["Lead & Opportunity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateLeadInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Lead", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Lead"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Leads": {"get": {"description": "Returns all defined Leads", "operationId": "Leads.list", "summary": "Leads.list", "tags": ["Lead & Opportunity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Leads are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Leads", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Lead"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Lead", "operationId": "Leads.create", "summary": "Leads.create", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Lead on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Lead", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createLeadInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Lead", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Lead"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Leads/batch-delete": {"post": {"description": "Removes Leads with given list of ids", "operationId": "Leads.batch_delete", "summary": "Leads.batch_delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Leads on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Leads. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Lead to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Lead.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Leads/batch-modify": {"post": {"description": "Create or update an batch of Leads", "operationId": "Leads.batch_create_or_update", "summary": "Leads.batch_create_or_update", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Leads on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Leads. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Lead", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchLeadInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Leads", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Leads/batch-restore": {"post": {"description": "Restores Leads with given list of ids", "operationId": "Leads.batch_restore", "summary": "Leads.batch_restore", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Leads on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Leads. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Lead to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Lead.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOppties/{id}": {"get": {"description": "Returns LeadOppty with given id", "operationId": "LeadOppties.get", "summary": "LeadOppties.get", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of LeadOppty to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "LeadOppty data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadOppty"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOppties": {"get": {"description": "Returns all defined LeadOppties", "operationId": "LeadOppties.list", "summary": "LeadOppties.list", "tags": ["Lead & Opportunity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted LeadOppties are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of LeadOppties", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/LeadOppty"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyAccountRelations/{id}": {"get": {"description": "Returns LeadOpptyAccountRelation with given id", "operationId": "LeadOpptyAccountRelations.get", "summary": "LeadOpptyAccountRelations.get", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of LeadOpptyAccountRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "LeadOpptyAccountRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadOpptyAccountRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes LeadOpptyAccountRelation with given id", "operationId": "LeadOpptyAccountRelations.delete", "summary": "LeadOpptyAccountRelations.delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of LeadOpptyAccountRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyAccountRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted LeadOpptyAccountRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies LeadOpptyAccountRelation or LeadOpptyAccountRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of LeadOpptyAccountRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyAccountRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "LeadOpptyAccountRelations.update", "summary": "LeadOpptyAccountRelations.update", "tags": ["Lead & Opportunity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateLeadOpptyAccountRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting LeadOpptyAccountRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadOpptyAccountRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyAccountRelations": {"get": {"description": "Returns all defined LeadOpptyAccountRelations", "operationId": "LeadOpptyAccountRelations.list", "summary": "LeadOpptyAccountRelations.list", "tags": ["Lead & Opportunity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted LeadOpptyAccountRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of LeadOpptyAccountRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/LeadOpptyAccountRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new LeadOpptyAccountRelation", "operationId": "LeadOpptyAccountRelations.create", "summary": "LeadOpptyAccountRelations.create", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyAccountRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new LeadOpptyAccountRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createLeadOpptyAccountRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created LeadOpptyAccountRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadOpptyAccountRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyAccountRelations/batch-delete": {"post": {"description": "Removes LeadOpptyAccountRelations with given list of ids", "operationId": "LeadOpptyAccountRelations.batch_delete", "summary": "LeadOpptyAccountRelations.batch_delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyAccountRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadOpptyAccountRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity LeadOpptyAccountRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted LeadOpptyAccountRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyAccountRelations/batch-modify": {"post": {"description": "Create or update an batch of LeadOpptyAccountRelations", "operationId": "LeadOpptyAccountRelations.batch_create_or_update", "summary": "LeadOpptyAccountRelations.batch_create_or_update", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyAccountRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadOpptyAccountRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new LeadOpptyAccountRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchLeadOpptyAccountRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated LeadOpptyAccountRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyAccountRelations/batch-restore": {"post": {"description": "Restores LeadOpptyAccountRelations with given list of ids", "operationId": "LeadOpptyAccountRelations.batch_restore", "summary": "LeadOpptyAccountRelations.batch_restore", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyAccountRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadOpptyAccountRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity LeadOpptyAccountRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored LeadOpptyAccountRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyContactGroupRelations/{id}": {"get": {"description": "Returns LeadOpptyContactGroupRelation with given id", "operationId": "LeadOpptyContactGroupRelations.get", "summary": "LeadOpptyContactGroupRelations.get", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of LeadOpptyContactGroupRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "LeadOpptyContactGroupRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadOpptyContactGroupRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes LeadOpptyContactGroupRelation with given id", "operationId": "LeadOpptyContactGroupRelations.delete", "summary": "LeadOpptyContactGroupRelations.delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of LeadOpptyContactGroupRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyContactGroupRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted LeadOpptyContactGroupRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies LeadOpptyContactGroupRelation or LeadOpptyContactGroupRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of LeadOpptyContactGroupRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyContactGroupRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "LeadOpptyContactGroupRelations.update", "summary": "LeadOpptyContactGroupRelations.update", "tags": ["Lead & Opportunity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateLeadOpptyContactGroupRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting LeadOpptyContactGroupRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadOpptyContactGroupRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyContactGroupRelations": {"get": {"description": "Returns all defined LeadOpptyContactGroupRelations", "operationId": "LeadOpptyContactGroupRelations.list", "summary": "LeadOpptyContactGroupRelations.list", "tags": ["Lead & Opportunity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted LeadOpptyContactGroupRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of LeadOpptyContactGroupRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/LeadOpptyContactGroupRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new LeadOpptyContactGroupRelation", "operationId": "LeadOpptyContactGroupRelations.create", "summary": "LeadOpptyContactGroupRelations.create", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyContactGroupRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new LeadOpptyContactGroupRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createLeadOpptyContactGroupRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created LeadOpptyContactGroupRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadOpptyContactGroupRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyContactGroupRelations/batch-delete": {"post": {"description": "Removes LeadOpptyContactGroupRelations with given list of ids", "operationId": "LeadOpptyContactGroupRelations.batch_delete", "summary": "LeadOpptyContactGroupRelations.batch_delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyContactGroupRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadOpptyContactGroupRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity LeadOpptyContactGroupRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted LeadOpptyContactGroupRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyContactGroupRelations/batch-modify": {"post": {"description": "Create or update an batch of LeadOpptyContactGroupRelations", "operationId": "LeadOpptyContactGroupRelations.batch_create_or_update", "summary": "LeadOpptyContactGroupRelations.batch_create_or_update", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyContactGroupRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadOpptyContactGroupRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new LeadOpptyContactGroupRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchLeadOpptyContactGroupRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated LeadOpptyContactGroupRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyContactGroupRelations/batch-restore": {"post": {"description": "Restores LeadOpptyContactGroupRelations with given list of ids", "operationId": "LeadOpptyContactGroupRelations.batch_restore", "summary": "LeadOpptyContactGroupRelations.batch_restore", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyContactGroupRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadOpptyContactGroupRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity LeadOpptyContactGroupRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored LeadOpptyContactGroupRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyContactRelations/{id}": {"get": {"description": "Returns LeadOpptyContactRelation with given id", "operationId": "LeadOpptyContactRelations.get", "summary": "LeadOpptyContactRelations.get", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of LeadOpptyContactRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "LeadOpptyContactRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadOpptyContactRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes LeadOpptyContactRelation with given id", "operationId": "LeadOpptyContactRelations.delete", "summary": "LeadOpptyContactRelations.delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of LeadOpptyContactRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyContactRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted LeadOpptyContactRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies LeadOpptyContactRelation or LeadOpptyContactRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of LeadOpptyContactRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyContactRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "LeadOpptyContactRelations.update", "summary": "LeadOpptyContactRelations.update", "tags": ["Lead & Opportunity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateLeadOpptyContactRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting LeadOpptyContactRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadOpptyContactRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyContactRelations": {"get": {"description": "Returns all defined LeadOpptyContactRelations", "operationId": "LeadOpptyContactRelations.list", "summary": "LeadOpptyContactRelations.list", "tags": ["Lead & Opportunity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted LeadOpptyContactRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of LeadOpptyContactRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/LeadOpptyContactRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new LeadOpptyContactRelation", "operationId": "LeadOpptyContactRelations.create", "summary": "LeadOpptyContactRelations.create", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyContactRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new LeadOpptyContactRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createLeadOpptyContactRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created LeadOpptyContactRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadOpptyContactRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyContactRelations/batch-delete": {"post": {"description": "Removes LeadOpptyContactRelations with given list of ids", "operationId": "LeadOpptyContactRelations.batch_delete", "summary": "LeadOpptyContactRelations.batch_delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyContactRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadOpptyContactRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity LeadOpptyContactRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted LeadOpptyContactRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyContactRelations/batch-modify": {"post": {"description": "Create or update an batch of LeadOpptyContactRelations", "operationId": "LeadOpptyContactRelations.batch_create_or_update", "summary": "LeadOpptyContactRelations.batch_create_or_update", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyContactRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadOpptyContactRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new LeadOpptyContactRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchLeadOpptyContactRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated LeadOpptyContactRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyContactRelations/batch-restore": {"post": {"description": "Restores LeadOpptyContactRelations with given list of ids", "operationId": "LeadOpptyContactRelations.batch_restore", "summary": "LeadOpptyContactRelations.batch_restore", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyContactRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadOpptyContactRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity LeadOpptyContactRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored LeadOpptyContactRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyContactSalesRoleRelations/{id}": {"get": {"description": "Returns LeadOpptyContactSalesRoleRelation with given id", "operationId": "LeadOpptyContactSalesRoleRelations.get", "summary": "LeadOpptyContactSalesRoleRelations.get", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of LeadOpptyContactSalesRoleRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "LeadOpptyContactSalesRoleRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadOpptyContactSalesRoleRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes LeadOpptyContactSalesRoleRelation with given id", "operationId": "LeadOpptyContactSalesRoleRelations.delete", "summary": "LeadOpptyContactSalesRoleRelations.delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of LeadOpptyContactSalesRoleRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyContactSalesRoleRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted LeadOpptyContactSalesRoleRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies LeadOpptyContactSalesRoleRelation or LeadOpptyContactSalesRoleRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of LeadOpptyContactSalesRoleRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyContactSalesRoleRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "LeadOpptyContactSalesRoleRelations.update", "summary": "LeadOpptyContactSalesRoleRelations.update", "tags": ["Lead & Opportunity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateLeadOpptyContactSalesRoleRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting LeadOpptyContactSalesRoleRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadOpptyContactSalesRoleRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyContactSalesRoleRelations": {"get": {"description": "Returns all defined LeadOpptyContactSalesRoleRelations", "operationId": "LeadOpptyContactSalesRoleRelations.list", "summary": "LeadOpptyContactSalesRoleRelations.list", "tags": ["Lead & Opportunity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted LeadOpptyContactSalesRoleRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of LeadOpptyContactSalesRoleRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/LeadOpptyContactSalesRoleRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new LeadOpptyContactSalesRoleRelation", "operationId": "LeadOpptyContactSalesRoleRelations.create", "summary": "LeadOpptyContactSalesRoleRelations.create", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyContactSalesRoleRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new LeadOpptyContactSalesRoleRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createLeadOpptyContactSalesRoleRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created LeadOpptyContactSalesRoleRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadOpptyContactSalesRoleRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyContactSalesRoleRelations/batch-delete": {"post": {"description": "Removes LeadOpptyContactSalesRoleRelations with given list of ids", "operationId": "LeadOpptyContactSalesRoleRelations.batch_delete", "summary": "LeadOpptyContactSalesRoleRelations.batch_delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyContactSalesRoleRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadOpptyContactSalesRoleRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity LeadOpptyContactSalesRoleRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted LeadOpptyContactSalesRoleRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyContactSalesRoleRelations/batch-modify": {"post": {"description": "Create or update an batch of LeadOpptyContactSalesRoleRelations", "operationId": "LeadOpptyContactSalesRoleRelations.batch_create_or_update", "summary": "LeadOpptyContactSalesRoleRelations.batch_create_or_update", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyContactSalesRoleRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadOpptyContactSalesRoleRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new LeadOpptyContactSalesRoleRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchLeadOpptyContactSalesRoleRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated LeadOpptyContactSalesRoleRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyContactSalesRoleRelations/batch-restore": {"post": {"description": "Restores LeadOpptyContactSalesRoleRelations with given list of ids", "operationId": "LeadOpptyContactSalesRoleRelations.batch_restore", "summary": "LeadOpptyContactSalesRoleRelations.batch_restore", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyContactSalesRoleRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadOpptyContactSalesRoleRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity LeadOpptyContactSalesRoleRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored LeadOpptyContactSalesRoleRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyDataExRelations/{id}": {"get": {"description": "Returns LeadOpptyDataExRelation with given id", "operationId": "LeadOpptyDataExRelations.get", "summary": "LeadOpptyDataExRelations.get", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of LeadOpptyDataExRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "LeadOpptyDataExRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadOpptyDataExRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyDataExRelations": {"get": {"description": "Returns all defined LeadOpptyDataExRelations", "operationId": "LeadOpptyDataExRelations.list", "summary": "LeadOpptyDataExRelations.list", "tags": ["Lead & Opportunity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted LeadOpptyDataExRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of LeadOpptyDataExRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/LeadOpptyDataExRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyKPIs/{id}": {"get": {"description": "Returns LeadOpptyKPI with given id", "operationId": "LeadOpptyKPIs.get", "summary": "LeadOpptyKPIs.get", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of LeadOpptyKPI to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "LeadOpptyKPI data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadOpptyKPI"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes LeadOpptyKPI with given id", "operationId": "LeadOpptyKPIs.delete", "summary": "LeadOpptyKPIs.delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of LeadOpptyKPI to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyKPI on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted LeadOpptyKPI", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies LeadOpptyKPI or LeadOpptyKPIs with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of LeadOpptyKPI to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyKPI on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "LeadOpptyKPIs.update", "summary": "LeadOpptyKPIs.update", "tags": ["Lead & Opportunity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateLeadOpptyKPIInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting LeadOpptyKPI", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadOpptyKPI"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyKPIs": {"get": {"description": "Returns all defined LeadOpptyKPIs", "operationId": "LeadOpptyKPIs.list", "summary": "LeadOpptyKPIs.list", "tags": ["Lead & Opportunity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted LeadOpptyKPIs are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of LeadOpptyKPIs", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/LeadOpptyKPI"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new LeadOpptyKPI", "operationId": "LeadOpptyKPIs.create", "summary": "LeadOpptyKPIs.create", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyKPI on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new LeadOpptyKPI", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createLeadOpptyKPIInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created LeadOpptyKPI", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadOpptyKPI"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyKPIs/batch-delete": {"post": {"description": "Removes LeadOpptyKPIs with given list of ids", "operationId": "LeadOpptyKPIs.batch_delete", "summary": "LeadOpptyKPIs.batch_delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyKPIs on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadOpptyKPIs. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity LeadOpptyKPI to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted LeadOpptyKPI.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyKPIs/batch-modify": {"post": {"description": "Create or update an batch of LeadOpptyKPIs", "operationId": "LeadOpptyKPIs.batch_create_or_update", "summary": "LeadOpptyKPIs.batch_create_or_update", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyKPIs on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadOpptyKPIs. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new LeadOpptyKPI", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchLeadOpptyKPIInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated LeadOpptyKPIs", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyKPIs/batch-restore": {"post": {"description": "Restores LeadOpptyKPIs with given list of ids", "operationId": "LeadOpptyKPIs.batch_restore", "summary": "LeadOpptyKPIs.batch_restore", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyKPIs on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadOpptyKPIs. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity LeadOpptyKPI to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored LeadOpptyKPI.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptySharingClientRelations/{id}": {"get": {"description": "Returns LeadOpptySharingClientRelation with given id", "operationId": "LeadOpptySharingClientRelations.get", "summary": "LeadOpptySharingClientRelations.get", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of LeadOpptySharingClientRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "LeadOpptySharingClientRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadOpptySharingClientRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes LeadOpptySharingClientRelation with given id", "operationId": "LeadOpptySharingClientRelations.delete", "summary": "LeadOpptySharingClientRelations.delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of LeadOpptySharingClientRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptySharingClientRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted LeadOpptySharingClientRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies LeadOpptySharingClientRelation or LeadOpptySharingClientRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of LeadOpptySharingClientRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptySharingClientRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "LeadOpptySharingClientRelations.update", "summary": "LeadOpptySharingClientRelations.update", "tags": ["Lead & Opportunity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateLeadOpptySharingClientRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting LeadOpptySharingClientRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadOpptySharingClientRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptySharingClientRelations": {"get": {"description": "Returns all defined LeadOpptySharingClientRelations", "operationId": "LeadOpptySharingClientRelations.list", "summary": "LeadOpptySharingClientRelations.list", "tags": ["Lead & Opportunity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted LeadOpptySharingClientRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of LeadOpptySharingClientRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/LeadOpptySharingClientRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new LeadOpptySharingClientRelation", "operationId": "LeadOpptySharingClientRelations.create", "summary": "LeadOpptySharingClientRelations.create", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptySharingClientRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new LeadOpptySharingClientRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createLeadOpptySharingClientRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created LeadOpptySharingClientRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadOpptySharingClientRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptySharingClientRelations/batch-delete": {"post": {"description": "Removes LeadOpptySharingClientRelations with given list of ids", "operationId": "LeadOpptySharingClientRelations.batch_delete", "summary": "LeadOpptySharingClientRelations.batch_delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptySharingClientRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadOpptySharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity LeadOpptySharingClientRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted LeadOpptySharingClientRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptySharingClientRelations/batch-modify": {"post": {"description": "Create or update an batch of LeadOpptySharingClientRelations", "operationId": "LeadOpptySharingClientRelations.batch_create_or_update", "summary": "LeadOpptySharingClientRelations.batch_create_or_update", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptySharingClientRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadOpptySharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new LeadOpptySharingClientRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchLeadOpptySharingClientRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated LeadOpptySharingClientRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptySharingClientRelations/batch-restore": {"post": {"description": "Restores LeadOpptySharingClientRelations with given list of ids", "operationId": "LeadOpptySharingClientRelations.batch_restore", "summary": "LeadOpptySharingClientRelations.batch_restore", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptySharingClientRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadOpptySharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity LeadOpptySharingClientRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored LeadOpptySharingClientRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptySharingSalesUnitRelations/{id}": {"get": {"description": "Returns LeadOpptySharingSalesUnitRelation with given id", "operationId": "LeadOpptySharingSalesUnitRelations.get", "summary": "LeadOpptySharingSalesUnitRelations.get", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of LeadOpptySharingSalesUnitRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "LeadOpptySharingSalesUnitRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadOpptySharingSalesUnitRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes LeadOpptySharingSalesUnitRelation with given id", "operationId": "LeadOpptySharingSalesUnitRelations.delete", "summary": "LeadOpptySharingSalesUnitRelations.delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of LeadOpptySharingSalesUnitRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptySharingSalesUnitRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted LeadOpptySharingSalesUnitRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies LeadOpptySharingSalesUnitRelation or LeadOpptySharingSalesUnitRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of LeadOpptySharingSalesUnitRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptySharingSalesUnitRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "LeadOpptySharingSalesUnitRelations.update", "summary": "LeadOpptySharingSalesUnitRelations.update", "tags": ["Lead & Opportunity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateLeadOpptySharingSalesUnitRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting LeadOpptySharingSalesUnitRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadOpptySharingSalesUnitRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptySharingSalesUnitRelations": {"get": {"description": "Returns all defined LeadOpptySharingSalesUnitRelations", "operationId": "LeadOpptySharingSalesUnitRelations.list", "summary": "LeadOpptySharingSalesUnitRelations.list", "tags": ["Lead & Opportunity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted LeadOpptySharingSalesUnitRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of LeadOpptySharingSalesUnitRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/LeadOpptySharingSalesUnitRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new LeadOpptySharingSalesUnitRelation", "operationId": "LeadOpptySharingSalesUnitRelations.create", "summary": "LeadOpptySharingSalesUnitRelations.create", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptySharingSalesUnitRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new LeadOpptySharingSalesUnitRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createLeadOpptySharingSalesUnitRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created LeadOpptySharingSalesUnitRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadOpptySharingSalesUnitRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptySharingSalesUnitRelations/batch-delete": {"post": {"description": "Removes LeadOpptySharingSalesUnitRelations with given list of ids", "operationId": "LeadOpptySharingSalesUnitRelations.batch_delete", "summary": "LeadOpptySharingSalesUnitRelations.batch_delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptySharingSalesUnitRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadOpptySharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity LeadOpptySharingSalesUnitRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted LeadOpptySharingSalesUnitRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptySharingSalesUnitRelations/batch-modify": {"post": {"description": "Create or update an batch of LeadOpptySharingSalesUnitRelations", "operationId": "LeadOpptySharingSalesUnitRelations.batch_create_or_update", "summary": "LeadOpptySharingSalesUnitRelations.batch_create_or_update", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptySharingSalesUnitRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadOpptySharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new LeadOpptySharingSalesUnitRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchLeadOpptySharingSalesUnitRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated LeadOpptySharingSalesUnitRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptySharingSalesUnitRelations/batch-restore": {"post": {"description": "Restores LeadOpptySharingSalesUnitRelations with given list of ids", "operationId": "LeadOpptySharingSalesUnitRelations.batch_restore", "summary": "LeadOpptySharingSalesUnitRelations.batch_restore", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptySharingSalesUnitRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadOpptySharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity LeadOpptySharingSalesUnitRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored LeadOpptySharingSalesUnitRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyStepCheckListRelations/{id}": {"get": {"description": "Returns LeadOpptyStepCheckListRelation with given id", "operationId": "LeadOpptyStepCheckListRelations.get", "summary": "LeadOpptyStepCheckListRelations.get", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of LeadOpptyStepCheckListRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "LeadOpptyStepCheckListRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadOpptyStepCheckListRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes LeadOpptyStepCheckListRelation with given id", "operationId": "LeadOpptyStepCheckListRelations.delete", "summary": "LeadOpptyStepCheckListRelations.delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of LeadOpptyStepCheckListRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyStepCheckListRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted LeadOpptyStepCheckListRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies LeadOpptyStepCheckListRelation or LeadOpptyStepCheckListRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of LeadOpptyStepCheckListRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyStepCheckListRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "LeadOpptyStepCheckListRelations.update", "summary": "LeadOpptyStepCheckListRelations.update", "tags": ["Lead & Opportunity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateLeadOpptyStepCheckListRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting LeadOpptyStepCheckListRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadOpptyStepCheckListRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyStepCheckListRelations": {"get": {"description": "Returns all defined LeadOpptyStepCheckListRelations", "operationId": "LeadOpptyStepCheckListRelations.list", "summary": "LeadOpptyStepCheckListRelations.list", "tags": ["Lead & Opportunity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted LeadOpptyStepCheckListRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of LeadOpptyStepCheckListRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/LeadOpptyStepCheckListRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new LeadOpptyStepCheckListRelation", "operationId": "LeadOpptyStepCheckListRelations.create", "summary": "LeadOpptyStepCheckListRelations.create", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyStepCheckListRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new LeadOpptyStepCheckListRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createLeadOpptyStepCheckListRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created LeadOpptyStepCheckListRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadOpptyStepCheckListRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyStepCheckListRelations/batch-delete": {"post": {"description": "Removes LeadOpptyStepCheckListRelations with given list of ids", "operationId": "LeadOpptyStepCheckListRelations.batch_delete", "summary": "LeadOpptyStepCheckListRelations.batch_delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyStepCheckListRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadOpptyStepCheckListRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity LeadOpptyStepCheckListRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted LeadOpptyStepCheckListRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyStepCheckListRelations/batch-modify": {"post": {"description": "Create or update an batch of LeadOpptyStepCheckListRelations", "operationId": "LeadOpptyStepCheckListRelations.batch_create_or_update", "summary": "LeadOpptyStepCheckListRelations.batch_create_or_update", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyStepCheckListRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadOpptyStepCheckListRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new LeadOpptyStepCheckListRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchLeadOpptyStepCheckListRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated LeadOpptyStepCheckListRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadOpptyStepCheckListRelations/batch-restore": {"post": {"description": "Restores LeadOpptyStepCheckListRelations with given list of ids", "operationId": "LeadOpptyStepCheckListRelations.batch_restore", "summary": "LeadOpptyStepCheckListRelations.batch_restore", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadOpptyStepCheckListRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadOpptyStepCheckListRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity LeadOpptyStepCheckListRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored LeadOpptyStepCheckListRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadProcesses/{id}": {"get": {"description": "Returns LeadProcess with given id", "operationId": "LeadProcesses.get", "summary": "LeadProcesses.get", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of LeadProcess to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "LeadProcess data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadProcess"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes LeadProcess with given id", "operationId": "LeadProcesses.delete", "summary": "LeadProcesses.delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of LeadProcess to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of LeadProcess on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted LeadProcess", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies LeadProcess or LeadProcesses with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of LeadProcess to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of LeadProcess on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "LeadProcesses.update", "summary": "LeadProcesses.update", "tags": ["Lead & Opportunity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateLeadProcessInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting LeadProcess", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadProcess"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadProcesses": {"get": {"description": "Returns all defined LeadProcesses", "operationId": "LeadProcesses.list", "summary": "LeadProcesses.list", "tags": ["Lead & Opportunity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted LeadProcesses are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of LeadProcesses", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/LeadProcess"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new LeadProcess", "operationId": "LeadProcesses.create", "summary": "LeadProcesses.create", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadProcess on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new LeadProcess", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createLeadProcessInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created LeadProcess", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadProcess"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadProcesses/batch-delete": {"post": {"description": "Removes LeadProcesses with given list of ids", "operationId": "LeadProcesses.batch_delete", "summary": "LeadProcesses.batch_delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadProcesses on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadProcesses. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity LeadProcess to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted LeadProcess.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadProcesses/batch-modify": {"post": {"description": "Create or update an batch of LeadProcesses", "operationId": "LeadProcesses.batch_create_or_update", "summary": "LeadProcesses.batch_create_or_update", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadProcesses on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadProcesses. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new LeadProcess", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchLeadProcessInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated LeadProcesses", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadProcesses/batch-restore": {"post": {"description": "Restores LeadProcesses with given list of ids", "operationId": "LeadProcesses.batch_restore", "summary": "LeadProcesses.batch_restore", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadProcesses on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadProcesses. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity LeadProcess to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored LeadProcess.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadTypes/{id}": {"get": {"description": "Returns LeadType with given id", "operationId": "LeadTypes.get", "summary": "LeadTypes.get", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of LeadType to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "LeadType data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes LeadType with given id", "operationId": "LeadTypes.delete", "summary": "LeadTypes.delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of LeadType to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of LeadType on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted LeadType", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies LeadType or LeadTypes with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of LeadType to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of LeadType on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "LeadTypes.update", "summary": "LeadTypes.update", "tags": ["Lead & Opportunity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateLeadTypeInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting LeadType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadTypes": {"get": {"description": "Returns all defined LeadTypes", "operationId": "LeadTypes.list", "summary": "LeadTypes.list", "tags": ["Lead & Opportunity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted LeadTypes are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of LeadTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/LeadType"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new LeadType", "operationId": "LeadTypes.create", "summary": "LeadTypes.create", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadType on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new LeadType", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createLeadTypeInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created LeadType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/LeadType"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadTypes/batch-delete": {"post": {"description": "Removes LeadTypes with given list of ids", "operationId": "LeadTypes.batch_delete", "summary": "LeadTypes.batch_delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadTypes on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity LeadType to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted LeadType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadTypes/batch-modify": {"post": {"description": "Create or update an batch of LeadTypes", "operationId": "LeadTypes.batch_create_or_update", "summary": "LeadTypes.batch_create_or_update", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadTypes on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new LeadType", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchLeadTypeInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated LeadTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/LeadTypes/batch-restore": {"post": {"description": "Restores LeadTypes with given list of ids", "operationId": "LeadTypes.batch_restore", "summary": "LeadTypes.batch_restore", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of LeadTypes on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for LeadTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity LeadType to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored LeadType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/MasterRights/{id}": {"get": {"description": "Returns MasterRight with given id", "operationId": "MasterRights.get", "summary": "MasterRights.get", "tags": ["MasterRight"], "parameters": [{"name": "id", "in": "path", "description": "ID of MasterRight to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "MasterRight data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/MasterRight"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes MasterRight with given id", "operationId": "MasterRights.delete", "summary": "MasterRights.delete", "tags": ["MasterRight"], "parameters": [{"name": "id", "in": "path", "description": "ID of MasterRight to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of MasterRight on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted MasterRight", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies MasterRight or MasterRights with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of MasterRight to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of MasterRight on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "MasterRights.update", "summary": "MasterRights.update", "tags": ["MasterRight"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateMasterRightInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting MasterRight", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/MasterRight"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/MasterRights": {"get": {"description": "Returns all defined MasterRights", "operationId": "MasterRights.list", "summary": "MasterRights.list", "tags": ["MasterRight"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted MasterRights are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of MasterRights", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/MasterRight"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new MasterRight", "operationId": "MasterRights.create", "summary": "MasterRights.create", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of MasterRight on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new MasterRight", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createMasterRightInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created MasterRight", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/MasterRight"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/MasterRights/batch-delete": {"post": {"description": "Removes MasterRights with given list of ids", "operationId": "MasterRights.batch_delete", "summary": "MasterRights.batch_delete", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of MasterRights on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for MasterRights. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity MasterRight to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted MasterRight.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/MasterRights/batch-modify": {"post": {"description": "Create or update an batch of MasterRights", "operationId": "MasterRights.batch_create_or_update", "summary": "MasterRights.batch_create_or_update", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of MasterRights on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for MasterRights. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new MasterRight", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchMasterRightInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated MasterRights", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/MasterRights/batch-restore": {"post": {"description": "Restores MasterRights with given list of ids", "operationId": "MasterRights.batch_restore", "summary": "MasterRights.batch_restore", "tags": ["MasterRight"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of MasterRights on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for MasterRights. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity MasterRight to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored MasterRight.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Medias/{id}": {"get": {"description": "Returns Media with given id", "operationId": "Medias.get", "summary": "Medias.get", "tags": ["Media"], "parameters": [{"name": "id", "in": "path", "description": "ID of Media to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Media data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Media"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Media with given id", "operationId": "Medias.delete", "summary": "Medias.delete", "tags": ["Media"], "parameters": [{"name": "id", "in": "path", "description": "ID of Media to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Media on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Media", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Media or Medias with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Media to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Media on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Medias.update", "summary": "Medias.update", "tags": ["Media"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateMediaInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Media", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Media"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Medias": {"get": {"description": "Returns all defined Medias", "operationId": "Medias.list", "summary": "Medias.list", "tags": ["Media"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Medias are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Medias", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Media"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Media", "operationId": "Medias.create", "summary": "Medias.create", "tags": ["Media"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Media on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Media", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createMediaInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Media", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Media"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Medias/batch-delete": {"post": {"description": "Removes Medias with given list of ids", "operationId": "Medias.batch_delete", "summary": "Medias.batch_delete", "tags": ["Media"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Medias on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Medias. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Media to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Media.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Medias/batch-modify": {"post": {"description": "Create or update an batch of Medias", "operationId": "Medias.batch_create_or_update", "summary": "Medias.batch_create_or_update", "tags": ["Media"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Medias on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Medias. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Media", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchMediaInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Medias", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Medias/batch-restore": {"post": {"description": "Restores Medias with given list of ids", "operationId": "Medias.batch_restore", "summary": "Medias.batch_restore", "tags": ["Media"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Medias on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Medias. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Media to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Media.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Memos/{id}": {"get": {"description": "Returns Memo with given id", "operationId": "Memos.get", "summary": "Memos.get", "tags": ["Memo"], "parameters": [{"name": "id", "in": "path", "description": "ID of Memo to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Memo data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Memo"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Memo with given id", "operationId": "Memos.delete", "summary": "Memos.delete", "tags": ["Memo"], "parameters": [{"name": "id", "in": "path", "description": "ID of Memo to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Memo on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Memo", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Memo or Memos with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Memo to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Memo on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Memos.update", "summary": "Memos.update", "tags": ["Memo"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateMemoInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Memo", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Memo"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Memos": {"get": {"description": "Returns all defined Memos", "operationId": "Memos.list", "summary": "Memos.list", "tags": ["Memo"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Memos are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Memos", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Memo"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Memo", "operationId": "Memos.create", "summary": "Memos.create", "tags": ["Memo"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Memo on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Memo", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createMemoInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Memo", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Memo"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Memos/batch-delete": {"post": {"description": "Removes Memos with given list of ids", "operationId": "Memos.batch_delete", "summary": "Memos.batch_delete", "tags": ["Memo"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Memos on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Memos. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Memo to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Memo.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Memos/batch-modify": {"post": {"description": "Create or update an batch of Memos", "operationId": "Memos.batch_create_or_update", "summary": "Memos.batch_create_or_update", "tags": ["Memo"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Memos on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Memos. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Memo", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchMemoInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Memos", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Memos/batch-restore": {"post": {"description": "Restores Memos with given list of ids", "operationId": "Memos.batch_restore", "summary": "Memos.batch_restore", "tags": ["Memo"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Memos on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Memos. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Memo to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Memo.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/MemoComments/{id}": {"get": {"description": "Returns MemoComment with given id", "operationId": "MemoComments.get", "summary": "MemoComments.get", "tags": ["Memo"], "parameters": [{"name": "id", "in": "path", "description": "ID of MemoComment to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "MemoComment data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/MemoComment"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes MemoComment with given id", "operationId": "MemoComments.delete", "summary": "MemoComments.delete", "tags": ["Memo"], "parameters": [{"name": "id", "in": "path", "description": "ID of MemoComment to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of MemoComment on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted MemoComment", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies MemoComment or MemoComments with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of MemoComment to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of MemoComment on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "MemoComments.update", "summary": "MemoComments.update", "tags": ["Memo"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateMemoCommentInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting MemoComment", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/MemoComment"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/MemoComments": {"get": {"description": "Returns all defined MemoComments", "operationId": "MemoComments.list", "summary": "MemoComments.list", "tags": ["Memo"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted MemoComments are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of MemoComments", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/MemoComment"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new MemoComment", "operationId": "MemoComments.create", "summary": "MemoComments.create", "tags": ["Memo"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of MemoComment on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new MemoComment", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createMemoCommentInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created MemoComment", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/MemoComment"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/MemoComments/batch-delete": {"post": {"description": "Removes MemoComments with given list of ids", "operationId": "MemoComments.batch_delete", "summary": "MemoComments.batch_delete", "tags": ["Memo"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of MemoComments on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for MemoComments. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity MemoComment to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted MemoComment.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/MemoComments/batch-modify": {"post": {"description": "Create or update an batch of MemoComments", "operationId": "MemoComments.batch_create_or_update", "summary": "MemoComments.batch_create_or_update", "tags": ["Memo"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of MemoComments on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for MemoComments. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new MemoComment", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchMemoCommentInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated MemoComments", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/MemoComments/batch-restore": {"post": {"description": "Restores MemoComments with given list of ids", "operationId": "MemoComments.batch_restore", "summary": "MemoComments.batch_restore", "tags": ["Memo"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of MemoComments on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for MemoComments. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity MemoComment to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored MemoComment.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/MessageRelations/{id}": {"get": {"description": "Returns MessageRelation with given id", "operationId": "MessageRelations.get", "summary": "MessageRelations.get", "tags": ["Message"], "parameters": [{"name": "id", "in": "path", "description": "ID of MessageRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "MessageRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/MessageRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes MessageRelation with given id", "operationId": "MessageRelations.delete", "summary": "MessageRelations.delete", "tags": ["Message"], "parameters": [{"name": "id", "in": "path", "description": "ID of MessageRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of MessageRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted MessageRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies MessageRelation or MessageRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of MessageRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of MessageRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "MessageRelations.update", "summary": "MessageRelations.update", "tags": ["Message"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateMessageRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting MessageRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/MessageRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/MessageRelations": {"get": {"description": "Returns all defined MessageRelations", "operationId": "MessageRelations.list", "summary": "MessageRelations.list", "tags": ["Message"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted MessageRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of MessageRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/MessageRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new MessageRelation", "operationId": "MessageRelations.create", "summary": "MessageRelations.create", "tags": ["Message"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of MessageRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new MessageRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createMessageRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created MessageRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/MessageRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/MessageRelations/batch-delete": {"post": {"description": "Removes MessageRelations with given list of ids", "operationId": "MessageRelations.batch_delete", "summary": "MessageRelations.batch_delete", "tags": ["Message"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of MessageRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for MessageRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity MessageRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted MessageRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/MessageRelations/batch-modify": {"post": {"description": "Create or update an batch of MessageRelations", "operationId": "MessageRelations.batch_create_or_update", "summary": "MessageRelations.batch_create_or_update", "tags": ["Message"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of MessageRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for MessageRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new MessageRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchMessageRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated MessageRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/MessageRelations/batch-restore": {"post": {"description": "Restores MessageRelations with given list of ids", "operationId": "MessageRelations.batch_restore", "summary": "MessageRelations.batch_restore", "tags": ["Message"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of MessageRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for MessageRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity MessageRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored MessageRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/MessageSharingClientRelations/{id}": {"get": {"description": "Returns MessageSharingClientRelation with given id", "operationId": "MessageSharingClientRelations.get", "summary": "MessageSharingClientRelations.get", "tags": ["Message"], "parameters": [{"name": "id", "in": "path", "description": "ID of MessageSharingClientRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "MessageSharingClientRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/MessageSharingClientRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes MessageSharingClientRelation with given id", "operationId": "MessageSharingClientRelations.delete", "summary": "MessageSharingClientRelations.delete", "tags": ["Message"], "parameters": [{"name": "id", "in": "path", "description": "ID of MessageSharingClientRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of MessageSharingClientRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted MessageSharingClientRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies MessageSharingClientRelation or MessageSharingClientRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of MessageSharingClientRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of MessageSharingClientRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "MessageSharingClientRelations.update", "summary": "MessageSharingClientRelations.update", "tags": ["Message"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateMessageSharingClientRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting MessageSharingClientRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/MessageSharingClientRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/MessageSharingClientRelations": {"get": {"description": "Returns all defined MessageSharingClientRelations", "operationId": "MessageSharingClientRelations.list", "summary": "MessageSharingClientRelations.list", "tags": ["Message"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted MessageSharingClientRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of MessageSharingClientRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/MessageSharingClientRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new MessageSharingClientRelation", "operationId": "MessageSharingClientRelations.create", "summary": "MessageSharingClientRelations.create", "tags": ["Message"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of MessageSharingClientRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new MessageSharingClientRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createMessageSharingClientRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created MessageSharingClientRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/MessageSharingClientRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/MessageSharingClientRelations/batch-delete": {"post": {"description": "Removes MessageSharingClientRelations with given list of ids", "operationId": "MessageSharingClientRelations.batch_delete", "summary": "MessageSharingClientRelations.batch_delete", "tags": ["Message"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of MessageSharingClientRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for MessageSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity MessageSharingClientRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted MessageSharingClientRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/MessageSharingClientRelations/batch-modify": {"post": {"description": "Create or update an batch of MessageSharingClientRelations", "operationId": "MessageSharingClientRelations.batch_create_or_update", "summary": "MessageSharingClientRelations.batch_create_or_update", "tags": ["Message"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of MessageSharingClientRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for MessageSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new MessageSharingClientRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchMessageSharingClientRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated MessageSharingClientRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/MessageSharingClientRelations/batch-restore": {"post": {"description": "Restores MessageSharingClientRelations with given list of ids", "operationId": "MessageSharingClientRelations.batch_restore", "summary": "MessageSharingClientRelations.batch_restore", "tags": ["Message"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of MessageSharingClientRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for MessageSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity MessageSharingClientRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored MessageSharingClientRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/MessageSharingSalesUnitRelations/{id}": {"get": {"description": "Returns MessageSharingSalesUnitRelation with given id", "operationId": "MessageSharingSalesUnitRelations.get", "summary": "MessageSharingSalesUnitRelations.get", "tags": ["Message"], "parameters": [{"name": "id", "in": "path", "description": "ID of MessageSharingSalesUnitRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "MessageSharingSalesUnitRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/MessageSharingSalesUnitRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes MessageSharingSalesUnitRelation with given id", "operationId": "MessageSharingSalesUnitRelations.delete", "summary": "MessageSharingSalesUnitRelations.delete", "tags": ["Message"], "parameters": [{"name": "id", "in": "path", "description": "ID of MessageSharingSalesUnitRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of MessageSharingSalesUnitRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted MessageSharingSalesUnitRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies MessageSharingSalesUnitRelation or MessageSharingSalesUnitRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of MessageSharingSalesUnitRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of MessageSharingSalesUnitRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "MessageSharingSalesUnitRelations.update", "summary": "MessageSharingSalesUnitRelations.update", "tags": ["Message"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateMessageSharingSalesUnitRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting MessageSharingSalesUnitRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/MessageSharingSalesUnitRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/MessageSharingSalesUnitRelations": {"get": {"description": "Returns all defined MessageSharingSalesUnitRelations", "operationId": "MessageSharingSalesUnitRelations.list", "summary": "MessageSharingSalesUnitRelations.list", "tags": ["Message"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted MessageSharingSalesUnitRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of MessageSharingSalesUnitRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/MessageSharingSalesUnitRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new MessageSharingSalesUnitRelation", "operationId": "MessageSharingSalesUnitRelations.create", "summary": "MessageSharingSalesUnitRelations.create", "tags": ["Message"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of MessageSharingSalesUnitRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new MessageSharingSalesUnitRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createMessageSharingSalesUnitRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created MessageSharingSalesUnitRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/MessageSharingSalesUnitRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/MessageSharingSalesUnitRelations/batch-delete": {"post": {"description": "Removes MessageSharingSalesUnitRelations with given list of ids", "operationId": "MessageSharingSalesUnitRelations.batch_delete", "summary": "MessageSharingSalesUnitRelations.batch_delete", "tags": ["Message"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of MessageSharingSalesUnitRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for MessageSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity MessageSharingSalesUnitRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted MessageSharingSalesUnitRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/MessageSharingSalesUnitRelations/batch-modify": {"post": {"description": "Create or update an batch of MessageSharingSalesUnitRelations", "operationId": "MessageSharingSalesUnitRelations.batch_create_or_update", "summary": "MessageSharingSalesUnitRelations.batch_create_or_update", "tags": ["Message"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of MessageSharingSalesUnitRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for MessageSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new MessageSharingSalesUnitRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchMessageSharingSalesUnitRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated MessageSharingSalesUnitRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/MessageSharingSalesUnitRelations/batch-restore": {"post": {"description": "Restores MessageSharingSalesUnitRelations with given list of ids", "operationId": "MessageSharingSalesUnitRelations.batch_restore", "summary": "MessageSharingSalesUnitRelations.batch_restore", "tags": ["Message"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of MessageSharingSalesUnitRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for MessageSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity MessageSharingSalesUnitRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored MessageSharingSalesUnitRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Notes/{id}": {"get": {"description": "Returns Note with given id", "operationId": "Notes.get", "summary": "Notes.get", "tags": ["Note"], "parameters": [{"name": "id", "in": "path", "description": "ID of Note to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Note data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Note"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Note with given id", "operationId": "Notes.delete", "summary": "Notes.delete", "tags": ["Note"], "parameters": [{"name": "id", "in": "path", "description": "ID of Note to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Note on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Note", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Note or Notes with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Note to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Note on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Notes.update", "summary": "Notes.update", "tags": ["Note"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateNoteInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Note", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Note"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Notes": {"get": {"description": "Returns all defined Notes", "operationId": "Notes.list", "summary": "Notes.list", "tags": ["Note"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Notes are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Notes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Note"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Note", "operationId": "Notes.create", "summary": "Notes.create", "tags": ["Note"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Note on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Note", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createNoteInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Note", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Note"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Notes/batch-delete": {"post": {"description": "Removes Notes with given list of ids", "operationId": "Notes.batch_delete", "summary": "Notes.batch_delete", "tags": ["Note"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Notes on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Notes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Note to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Note.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Notes/batch-modify": {"post": {"description": "Create or update an batch of Notes", "operationId": "Notes.batch_create_or_update", "summary": "Notes.batch_create_or_update", "tags": ["Note"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Notes on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Notes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Note", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchNoteInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Notes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Notes/batch-restore": {"post": {"description": "Restores Notes with given list of ids", "operationId": "Notes.batch_restore", "summary": "Notes.batch_restore", "tags": ["Note"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Notes on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Notes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Note to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Note.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineForms/{id}": {"get": {"description": "Returns OnlineForm with given id", "operationId": "OnlineForms.get", "summary": "OnlineForms.get", "tags": ["Online"], "parameters": [{"name": "id", "in": "path", "description": "ID of OnlineForm to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OnlineForm data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OnlineForm"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes OnlineForm with given id", "operationId": "OnlineForms.delete", "summary": "OnlineForms.delete", "tags": ["Online"], "parameters": [{"name": "id", "in": "path", "description": "ID of OnlineForm to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineForm on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted OnlineForm", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies OnlineForm or OnlineForms with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of OnlineForm to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineForm on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "OnlineForms.update", "summary": "OnlineForms.update", "tags": ["Online"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateOnlineFormInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting OnlineForm", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OnlineForm"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineForms": {"get": {"description": "Returns all defined OnlineForms", "operationId": "OnlineForms.list", "summary": "OnlineForms.list", "tags": ["Online"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted OnlineForms are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of OnlineForms", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/OnlineForm"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new OnlineForm", "operationId": "OnlineForms.create", "summary": "OnlineForms.create", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineForm on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OnlineForm", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createOnlineFormInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created OnlineForm", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OnlineForm"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineForms/batch-delete": {"post": {"description": "Removes OnlineForms with given list of ids", "operationId": "OnlineForms.batch_delete", "summary": "OnlineForms.batch_delete", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineForms on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OnlineForms. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OnlineForm to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted OnlineForm.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineForms/batch-modify": {"post": {"description": "Create or update an batch of OnlineForms", "operationId": "OnlineForms.batch_create_or_update", "summary": "OnlineForms.batch_create_or_update", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineForms on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OnlineForms. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OnlineForm", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchOnlineFormInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated OnlineForms", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineForms/batch-restore": {"post": {"description": "Restores OnlineForms with given list of ids", "operationId": "OnlineForms.batch_restore", "summary": "OnlineForms.batch_restore", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineForms on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OnlineForms. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OnlineForm to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored OnlineForm.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormActivityLogLines/{id}": {"get": {"description": "Returns OnlineFormActivityLogLine with given id", "operationId": "OnlineFormActivityLogLines.get", "summary": "OnlineFormActivityLogLines.get", "tags": ["Online"], "parameters": [{"name": "id", "in": "path", "description": "ID of OnlineFormActivityLogLine to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OnlineFormActivityLogLine data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OnlineFormActivityLogLine"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes OnlineFormActivityLogLine with given id", "operationId": "OnlineFormActivityLogLines.delete", "summary": "OnlineFormActivityLogLines.delete", "tags": ["Online"], "parameters": [{"name": "id", "in": "path", "description": "ID of OnlineFormActivityLogLine to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormActivityLogLine on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted OnlineFormActivityLogLine", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies OnlineFormActivityLogLine or OnlineFormActivityLogLines with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of OnlineFormActivityLogLine to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormActivityLogLine on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "OnlineFormActivityLogLines.update", "summary": "OnlineFormActivityLogLines.update", "tags": ["Online"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateOnlineFormActivityLogLineInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting OnlineFormActivityLogLine", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OnlineFormActivityLogLine"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormActivityLogLines": {"get": {"description": "Returns all defined OnlineFormActivityLogLines", "operationId": "OnlineFormActivityLogLines.list", "summary": "OnlineFormActivityLogLines.list", "tags": ["Online"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted OnlineFormActivityLogLines are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of OnlineFormActivityLogLines", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/OnlineFormActivityLogLine"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new OnlineFormActivityLogLine", "operationId": "OnlineFormActivityLogLines.create", "summary": "OnlineFormActivityLogLines.create", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormActivityLogLine on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OnlineFormActivityLogLine", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createOnlineFormActivityLogLineInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created OnlineFormActivityLogLine", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OnlineFormActivityLogLine"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormActivityLogLines/batch-delete": {"post": {"description": "Removes OnlineFormActivityLogLines with given list of ids", "operationId": "OnlineFormActivityLogLines.batch_delete", "summary": "OnlineFormActivityLogLines.batch_delete", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormActivityLogLines on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OnlineFormActivityLogLines. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OnlineFormActivityLogLine to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted OnlineFormActivityLogLine.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormActivityLogLines/batch-modify": {"post": {"description": "Create or update an batch of OnlineFormActivityLogLines", "operationId": "OnlineFormActivityLogLines.batch_create_or_update", "summary": "OnlineFormActivityLogLines.batch_create_or_update", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormActivityLogLines on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OnlineFormActivityLogLines. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OnlineFormActivityLogLine", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchOnlineFormActivityLogLineInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated OnlineFormActivityLogLines", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormActivityLogLines/batch-restore": {"post": {"description": "Restores OnlineFormActivityLogLines with given list of ids", "operationId": "OnlineFormActivityLogLines.batch_restore", "summary": "OnlineFormActivityLogLines.batch_restore", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormActivityLogLines on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OnlineFormActivityLogLines. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OnlineFormActivityLogLine to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored OnlineFormActivityLogLine.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormDataExRelations/{id}": {"get": {"description": "Returns OnlineFormDataExRelation with given id", "operationId": "OnlineFormDataExRelations.get", "summary": "OnlineFormDataExRelations.get", "tags": ["Online"], "parameters": [{"name": "id", "in": "path", "description": "ID of OnlineFormDataExRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OnlineFormDataExRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OnlineFormDataExRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes OnlineFormDataExRelation with given id", "operationId": "OnlineFormDataExRelations.delete", "summary": "OnlineFormDataExRelations.delete", "tags": ["Online"], "parameters": [{"name": "id", "in": "path", "description": "ID of OnlineFormDataExRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormDataExRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted OnlineFormDataExRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies OnlineFormDataExRelation or OnlineFormDataExRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of OnlineFormDataExRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormDataExRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "OnlineFormDataExRelations.update", "summary": "OnlineFormDataExRelations.update", "tags": ["Online"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateOnlineFormDataExRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting OnlineFormDataExRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OnlineFormDataExRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormDataExRelations": {"get": {"description": "Returns all defined OnlineFormDataExRelations", "operationId": "OnlineFormDataExRelations.list", "summary": "OnlineFormDataExRelations.list", "tags": ["Online"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted OnlineFormDataExRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of OnlineFormDataExRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/OnlineFormDataExRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new OnlineFormDataExRelation", "operationId": "OnlineFormDataExRelations.create", "summary": "OnlineFormDataExRelations.create", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormDataExRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OnlineFormDataExRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createOnlineFormDataExRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created OnlineFormDataExRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OnlineFormDataExRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormDataExRelations/batch-delete": {"post": {"description": "Removes OnlineFormDataExRelations with given list of ids", "operationId": "OnlineFormDataExRelations.batch_delete", "summary": "OnlineFormDataExRelations.batch_delete", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormDataExRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OnlineFormDataExRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OnlineFormDataExRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted OnlineFormDataExRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormDataExRelations/batch-modify": {"post": {"description": "Create or update an batch of OnlineFormDataExRelations", "operationId": "OnlineFormDataExRelations.batch_create_or_update", "summary": "OnlineFormDataExRelations.batch_create_or_update", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormDataExRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OnlineFormDataExRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OnlineFormDataExRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchOnlineFormDataExRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated OnlineFormDataExRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormDataExRelations/batch-restore": {"post": {"description": "Restores OnlineFormDataExRelations with given list of ids", "operationId": "OnlineFormDataExRelations.batch_restore", "summary": "OnlineFormDataExRelations.batch_restore", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormDataExRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OnlineFormDataExRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OnlineFormDataExRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored OnlineFormDataExRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormRelations/{id}": {"get": {"description": "Returns OnlineFormRelation with given id", "operationId": "OnlineFormRelations.get", "summary": "OnlineFormRelations.get", "tags": ["Online"], "parameters": [{"name": "id", "in": "path", "description": "ID of OnlineFormRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OnlineFormRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OnlineFormRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes OnlineFormRelation with given id", "operationId": "OnlineFormRelations.delete", "summary": "OnlineFormRelations.delete", "tags": ["Online"], "parameters": [{"name": "id", "in": "path", "description": "ID of OnlineFormRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted OnlineFormRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies OnlineFormRelation or OnlineFormRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of OnlineFormRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "OnlineFormRelations.update", "summary": "OnlineFormRelations.update", "tags": ["Online"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateOnlineFormRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting OnlineFormRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OnlineFormRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormRelations": {"get": {"description": "Returns all defined OnlineFormRelations", "operationId": "OnlineFormRelations.list", "summary": "OnlineFormRelations.list", "tags": ["Online"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted OnlineFormRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of OnlineFormRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/OnlineFormRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new OnlineFormRelation", "operationId": "OnlineFormRelations.create", "summary": "OnlineFormRelations.create", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OnlineFormRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createOnlineFormRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created OnlineFormRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OnlineFormRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormRelations/batch-delete": {"post": {"description": "Removes OnlineFormRelations with given list of ids", "operationId": "OnlineFormRelations.batch_delete", "summary": "OnlineFormRelations.batch_delete", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OnlineFormRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OnlineFormRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted OnlineFormRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormRelations/batch-modify": {"post": {"description": "Create or update an batch of OnlineFormRelations", "operationId": "OnlineFormRelations.batch_create_or_update", "summary": "OnlineFormRelations.batch_create_or_update", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OnlineFormRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OnlineFormRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchOnlineFormRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated OnlineFormRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormRelations/batch-restore": {"post": {"description": "Restores OnlineFormRelations with given list of ids", "operationId": "OnlineFormRelations.batch_restore", "summary": "OnlineFormRelations.batch_restore", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OnlineFormRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OnlineFormRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored OnlineFormRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormStyles/{id}": {"get": {"description": "Returns OnlineFormStyle with given id", "operationId": "OnlineFormStyles.get", "summary": "OnlineFormStyles.get", "tags": ["Online"], "parameters": [{"name": "id", "in": "path", "description": "ID of OnlineFormStyle to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OnlineFormStyle data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OnlineFormStyle"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes OnlineFormStyle with given id", "operationId": "OnlineFormStyles.delete", "summary": "OnlineFormStyles.delete", "tags": ["Online"], "parameters": [{"name": "id", "in": "path", "description": "ID of OnlineFormStyle to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormStyle on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted OnlineFormStyle", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies OnlineFormStyle or OnlineFormStyles with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of OnlineFormStyle to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormStyle on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "OnlineFormStyles.update", "summary": "OnlineFormStyles.update", "tags": ["Online"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateOnlineFormStyleInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting OnlineFormStyle", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OnlineFormStyle"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormStyles": {"get": {"description": "Returns all defined OnlineFormStyles", "operationId": "OnlineFormStyles.list", "summary": "OnlineFormStyles.list", "tags": ["Online"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted OnlineFormStyles are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of OnlineFormStyles", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/OnlineFormStyle"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new OnlineFormStyle", "operationId": "OnlineFormStyles.create", "summary": "OnlineFormStyles.create", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormStyle on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OnlineFormStyle", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createOnlineFormStyleInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created OnlineFormStyle", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OnlineFormStyle"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormStyles/batch-delete": {"post": {"description": "Removes OnlineFormStyles with given list of ids", "operationId": "OnlineFormStyles.batch_delete", "summary": "OnlineFormStyles.batch_delete", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormStyles on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OnlineFormStyles. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OnlineFormStyle to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted OnlineFormStyle.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormStyles/batch-modify": {"post": {"description": "Create or update an batch of OnlineFormStyles", "operationId": "OnlineFormStyles.batch_create_or_update", "summary": "OnlineFormStyles.batch_create_or_update", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormStyles on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OnlineFormStyles. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OnlineFormStyle", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchOnlineFormStyleInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated OnlineFormStyles", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormStyles/batch-restore": {"post": {"description": "Restores OnlineFormStyles with given list of ids", "operationId": "OnlineFormStyles.batch_restore", "summary": "OnlineFormStyles.batch_restore", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormStyles on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OnlineFormStyles. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OnlineFormStyle to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored OnlineFormStyle.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormTypes/{id}": {"get": {"description": "Returns OnlineFormType with given id", "operationId": "OnlineFormTypes.get", "summary": "OnlineFormTypes.get", "tags": ["Online"], "parameters": [{"name": "id", "in": "path", "description": "ID of OnlineFormType to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OnlineFormType data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OnlineFormType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes OnlineFormType with given id", "operationId": "OnlineFormTypes.delete", "summary": "OnlineFormTypes.delete", "tags": ["Online"], "parameters": [{"name": "id", "in": "path", "description": "ID of OnlineFormType to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormType on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted OnlineFormType", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies OnlineFormType or OnlineFormTypes with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of OnlineFormType to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormType on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "OnlineFormTypes.update", "summary": "OnlineFormTypes.update", "tags": ["Online"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateOnlineFormTypeInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting OnlineFormType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OnlineFormType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormTypes": {"get": {"description": "Returns all defined OnlineFormTypes", "operationId": "OnlineFormTypes.list", "summary": "OnlineFormTypes.list", "tags": ["Online"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted OnlineFormTypes are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of OnlineFormTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/OnlineFormType"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new OnlineFormType", "operationId": "OnlineFormTypes.create", "summary": "OnlineFormTypes.create", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormType on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OnlineFormType", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createOnlineFormTypeInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created OnlineFormType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OnlineFormType"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormTypes/batch-delete": {"post": {"description": "Removes OnlineFormTypes with given list of ids", "operationId": "OnlineFormTypes.batch_delete", "summary": "OnlineFormTypes.batch_delete", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormTypes on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OnlineFormTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OnlineFormType to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted OnlineFormType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormTypes/batch-modify": {"post": {"description": "Create or update an batch of OnlineFormTypes", "operationId": "OnlineFormTypes.batch_create_or_update", "summary": "OnlineFormTypes.batch_create_or_update", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormTypes on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OnlineFormTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OnlineFormType", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchOnlineFormTypeInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated OnlineFormTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormTypes/batch-restore": {"post": {"description": "Restores OnlineFormTypes with given list of ids", "operationId": "OnlineFormTypes.batch_restore", "summary": "OnlineFormTypes.batch_restore", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormTypes on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OnlineFormTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OnlineFormType to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored OnlineFormType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormTypeEmailRelations/{id}": {"get": {"description": "Returns OnlineFormTypeEmailRelation with given id", "operationId": "OnlineFormTypeEmailRelations.get", "summary": "OnlineFormTypeEmailRelations.get", "tags": ["Online"], "parameters": [{"name": "id", "in": "path", "description": "ID of OnlineFormTypeEmailRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OnlineFormTypeEmailRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OnlineFormTypeEmailRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes OnlineFormTypeEmailRelation with given id", "operationId": "OnlineFormTypeEmailRelations.delete", "summary": "OnlineFormTypeEmailRelations.delete", "tags": ["Online"], "parameters": [{"name": "id", "in": "path", "description": "ID of OnlineFormTypeEmailRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormTypeEmailRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted OnlineFormTypeEmailRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies OnlineFormTypeEmailRelation or OnlineFormTypeEmailRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of OnlineFormTypeEmailRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormTypeEmailRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "OnlineFormTypeEmailRelations.update", "summary": "OnlineFormTypeEmailRelations.update", "tags": ["Online"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateOnlineFormTypeEmailRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting OnlineFormTypeEmailRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OnlineFormTypeEmailRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormTypeEmailRelations": {"get": {"description": "Returns all defined OnlineFormTypeEmailRelations", "operationId": "OnlineFormTypeEmailRelations.list", "summary": "OnlineFormTypeEmailRelations.list", "tags": ["Online"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted OnlineFormTypeEmailRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of OnlineFormTypeEmailRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/OnlineFormTypeEmailRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new OnlineFormTypeEmailRelation", "operationId": "OnlineFormTypeEmailRelations.create", "summary": "OnlineFormTypeEmailRelations.create", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormTypeEmailRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OnlineFormTypeEmailRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createOnlineFormTypeEmailRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created OnlineFormTypeEmailRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OnlineFormTypeEmailRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormTypeEmailRelations/batch-delete": {"post": {"description": "Removes OnlineFormTypeEmailRelations with given list of ids", "operationId": "OnlineFormTypeEmailRelations.batch_delete", "summary": "OnlineFormTypeEmailRelations.batch_delete", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormTypeEmailRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OnlineFormTypeEmailRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OnlineFormTypeEmailRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted OnlineFormTypeEmailRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormTypeEmailRelations/batch-modify": {"post": {"description": "Create or update an batch of OnlineFormTypeEmailRelations", "operationId": "OnlineFormTypeEmailRelations.batch_create_or_update", "summary": "OnlineFormTypeEmailRelations.batch_create_or_update", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormTypeEmailRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OnlineFormTypeEmailRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OnlineFormTypeEmailRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchOnlineFormTypeEmailRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated OnlineFormTypeEmailRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OnlineFormTypeEmailRelations/batch-restore": {"post": {"description": "Restores OnlineFormTypeEmailRelations with given list of ids", "operationId": "OnlineFormTypeEmailRelations.batch_restore", "summary": "OnlineFormTypeEmailRelations.batch_restore", "tags": ["Online"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OnlineFormTypeEmailRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OnlineFormTypeEmailRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OnlineFormTypeEmailRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored OnlineFormTypeEmailRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Opportunities/{id}": {"get": {"description": "Returns Opportunity with given id", "operationId": "Opportunities.get", "summary": "Opportunities.get", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of Opportunity to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Opportunity data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Opportunity"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Opportunity with given id", "operationId": "Opportunities.delete", "summary": "Opportunities.delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of Opportunity to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Opportunity on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Opportunity", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Opportunity or Opportunities with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Opportunity to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Opportunity on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Opportunities.update", "summary": "Opportunities.update", "tags": ["Lead & Opportunity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateOpportunityInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Opportunity", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Opportunity"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Opportunities": {"get": {"description": "Returns all defined Opportunities", "operationId": "Opportunities.list", "summary": "Opportunities.list", "tags": ["Lead & Opportunity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Opportunities are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Opportunities", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Opportunity"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Opportunity", "operationId": "Opportunities.create", "summary": "Opportunities.create", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Opportunity on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Opportunity", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createOpportunityInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Opportunity", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Opportunity"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Opportunities/batch-delete": {"post": {"description": "Removes Opportunities with given list of ids", "operationId": "Opportunities.batch_delete", "summary": "Opportunities.batch_delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Opportunities on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Opportunities. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Opportunity to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Opportunity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Opportunities/batch-modify": {"post": {"description": "Create or update an batch of Opportunities", "operationId": "Opportunities.batch_create_or_update", "summary": "Opportunities.batch_create_or_update", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Opportunities on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Opportunities. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Opportunity", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchOpportunityInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Opportunities", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Opportunities/batch-restore": {"post": {"description": "Restores Opportunities with given list of ids", "operationId": "Opportunities.batch_restore", "summary": "Opportunities.batch_restore", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Opportunities on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Opportunities. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Opportunity to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Opportunity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpportunityTypes/{id}": {"get": {"description": "Returns OpportunityType with given id", "operationId": "OpportunityTypes.get", "summary": "OpportunityTypes.get", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of OpportunityType to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OpportunityType data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpportunityType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes OpportunityType with given id", "operationId": "OpportunityTypes.delete", "summary": "OpportunityTypes.delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of OpportunityType to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OpportunityType on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted OpportunityType", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies OpportunityType or OpportunityTypes with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of OpportunityType to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OpportunityType on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "OpportunityTypes.update", "summary": "OpportunityTypes.update", "tags": ["Lead & Opportunity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateOpportunityTypeInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting OpportunityType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpportunityType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpportunityTypes": {"get": {"description": "Returns all defined OpportunityTypes", "operationId": "OpportunityTypes.list", "summary": "OpportunityTypes.list", "tags": ["Lead & Opportunity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted OpportunityTypes are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of OpportunityTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/OpportunityType"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new OpportunityType", "operationId": "OpportunityTypes.create", "summary": "OpportunityTypes.create", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpportunityType on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OpportunityType", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createOpportunityTypeInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created OpportunityType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpportunityType"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpportunityTypes/batch-delete": {"post": {"description": "Removes OpportunityTypes with given list of ids", "operationId": "OpportunityTypes.batch_delete", "summary": "OpportunityTypes.batch_delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpportunityTypes on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpportunityTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OpportunityType to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted OpportunityType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpportunityTypes/batch-modify": {"post": {"description": "Create or update an batch of OpportunityTypes", "operationId": "OpportunityTypes.batch_create_or_update", "summary": "OpportunityTypes.batch_create_or_update", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpportunityTypes on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpportunityTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OpportunityType", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchOpportunityTypeInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated OpportunityTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpportunityTypes/batch-restore": {"post": {"description": "Restores OpportunityTypes with given list of ids", "operationId": "OpportunityTypes.batch_restore", "summary": "OpportunityTypes.batch_restore", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpportunityTypes on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpportunityTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OpportunityType to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored OpportunityType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyProductRelations/{id}": {"get": {"description": "Returns OpptyProductRelation with given id", "operationId": "OpptyProductRelations.get", "summary": "OpptyProductRelations.get", "tags": ["Product Line Items"], "parameters": [{"name": "id", "in": "path", "description": "ID of OpptyProductRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OpptyProductRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpptyProductRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes OpptyProductRelation with given id", "operationId": "OpptyProductRelations.delete", "summary": "OpptyProductRelations.delete", "tags": ["Product Line Items"], "parameters": [{"name": "id", "in": "path", "description": "ID of OpptyProductRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted OpptyProductRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies OpptyProductRelation or OpptyProductRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of OpptyProductRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "OpptyProductRelations.update", "summary": "OpptyProductRelations.update", "tags": ["Product Line Items"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateOpptyProductRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting OpptyProductRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpptyProductRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyProductRelations": {"get": {"description": "Returns all defined OpptyProductRelations", "operationId": "OpptyProductRelations.list", "summary": "OpptyProductRelations.list", "tags": ["Product Line Items"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted OpptyProductRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of OpptyProductRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/OpptyProductRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new OpptyProductRelation", "operationId": "OpptyProductRelations.create", "summary": "OpptyProductRelations.create", "tags": ["Product Line Items"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OpptyProductRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createOpptyProductRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created OpptyProductRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpptyProductRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyProductRelations/batch-delete": {"post": {"description": "Removes OpptyProductRelations with given list of ids", "operationId": "OpptyProductRelations.batch_delete", "summary": "OpptyProductRelations.batch_delete", "tags": ["Product Line Items"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpptyProductRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OpptyProductRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted OpptyProductRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyProductRelations/batch-modify": {"post": {"description": "Create or update an batch of OpptyProductRelations", "operationId": "OpptyProductRelations.batch_create_or_update", "summary": "OpptyProductRelations.batch_create_or_update", "tags": ["Product Line Items"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpptyProductRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OpptyProductRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchOpptyProductRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated OpptyProductRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyProductRelations/batch-restore": {"post": {"description": "Restores OpptyProductRelations with given list of ids", "operationId": "OpptyProductRelations.batch_restore", "summary": "OpptyProductRelations.batch_restore", "tags": ["Product Line Items"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpptyProductRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OpptyProductRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored OpptyProductRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyProductRelationDataExRelations/{id}": {"get": {"description": "Returns OpptyProductRelationDataExRelation with given id", "operationId": "OpptyProductRelationDataExRelations.get", "summary": "OpptyProductRelationDataExRelations.get", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of OpptyProductRelationDataExRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OpptyProductRelationDataExRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpptyProductRelationDataExRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes OpptyProductRelationDataExRelation with given id", "operationId": "OpptyProductRelationDataExRelations.delete", "summary": "OpptyProductRelationDataExRelations.delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of OpptyProductRelationDataExRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelationDataExRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted OpptyProductRelationDataExRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies OpptyProductRelationDataExRelation or OpptyProductRelationDataExRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of OpptyProductRelationDataExRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelationDataExRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "OpptyProductRelationDataExRelations.update", "summary": "OpptyProductRelationDataExRelations.update", "tags": ["Lead & Opportunity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateOpptyProductRelationDataExRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting OpptyProductRelationDataExRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpptyProductRelationDataExRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyProductRelationDataExRelations": {"get": {"description": "Returns all defined OpptyProductRelationDataExRelations", "operationId": "OpptyProductRelationDataExRelations.list", "summary": "OpptyProductRelationDataExRelations.list", "tags": ["Lead & Opportunity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted OpptyProductRelationDataExRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of OpptyProductRelationDataExRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/OpptyProductRelationDataExRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new OpptyProductRelationDataExRelation", "operationId": "OpptyProductRelationDataExRelations.create", "summary": "OpptyProductRelationDataExRelations.create", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelationDataExRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OpptyProductRelationDataExRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createOpptyProductRelationDataExRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created OpptyProductRelationDataExRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpptyProductRelationDataExRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyProductRelationDataExRelations/batch-delete": {"post": {"description": "Removes OpptyProductRelationDataExRelations with given list of ids", "operationId": "OpptyProductRelationDataExRelations.batch_delete", "summary": "OpptyProductRelationDataExRelations.batch_delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelationDataExRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpptyProductRelationDataExRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OpptyProductRelationDataExRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted OpptyProductRelationDataExRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyProductRelationDataExRelations/batch-modify": {"post": {"description": "Create or update an batch of OpptyProductRelationDataExRelations", "operationId": "OpptyProductRelationDataExRelations.batch_create_or_update", "summary": "OpptyProductRelationDataExRelations.batch_create_or_update", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelationDataExRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpptyProductRelationDataExRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OpptyProductRelationDataExRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchOpptyProductRelationDataExRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated OpptyProductRelationDataExRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyProductRelationDataExRelations/batch-restore": {"post": {"description": "Restores OpptyProductRelationDataExRelations with given list of ids", "operationId": "OpptyProductRelationDataExRelations.batch_restore", "summary": "OpptyProductRelationDataExRelations.batch_restore", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelationDataExRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpptyProductRelationDataExRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OpptyProductRelationDataExRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored OpptyProductRelationDataExRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyProductRelationRevenueSchedules/{id}": {"get": {"description": "Returns OpptyProductRelationRevenueSchedule with given id", "operationId": "OpptyProductRelationRevenueSchedules.get", "summary": "OpptyProductRelationRevenueSchedules.get", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of OpptyProductRelationRevenueSchedule to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OpptyProductRelationRevenueSchedule data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpptyProductRelationRevenueSchedule"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes OpptyProductRelationRevenueSchedule with given id", "operationId": "OpptyProductRelationRevenueSchedules.delete", "summary": "OpptyProductRelationRevenueSchedules.delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of OpptyProductRelationRevenueSchedule to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelationRevenueSchedule on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted OpptyProductRelationRevenueSchedule", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies OpptyProductRelationRevenueSchedule or OpptyProductRelationRevenueSchedules with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of OpptyProductRelationRevenueSchedule to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelationRevenueSchedule on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "OpptyProductRelationRevenueSchedules.update", "summary": "OpptyProductRelationRevenueSchedules.update", "tags": ["Lead & Opportunity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateOpptyProductRelationRevenueScheduleInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting OpptyProductRelationRevenueSchedule", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpptyProductRelationRevenueSchedule"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyProductRelationRevenueSchedules": {"get": {"description": "Returns all defined OpptyProductRelationRevenueSchedules", "operationId": "OpptyProductRelationRevenueSchedules.list", "summary": "OpptyProductRelationRevenueSchedules.list", "tags": ["Lead & Opportunity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted OpptyProductRelationRevenueSchedules are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of OpptyProductRelationRevenueSchedules", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/OpptyProductRelationRevenueSchedule"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new OpptyProductRelationRevenueSchedule", "operationId": "OpptyProductRelationRevenueSchedules.create", "summary": "OpptyProductRelationRevenueSchedules.create", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelationRevenueSchedule on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OpptyProductRelationRevenueSchedule", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createOpptyProductRelationRevenueScheduleInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created OpptyProductRelationRevenueSchedule", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpptyProductRelationRevenueSchedule"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyProductRelationRevenueSchedules/batch-delete": {"post": {"description": "Removes OpptyProductRelationRevenueSchedules with given list of ids", "operationId": "OpptyProductRelationRevenueSchedules.batch_delete", "summary": "OpptyProductRelationRevenueSchedules.batch_delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelationRevenueSchedules on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpptyProductRelationRevenueSchedules. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OpptyProductRelationRevenueSchedule to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted OpptyProductRelationRevenueSchedule.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyProductRelationRevenueSchedules/batch-modify": {"post": {"description": "Create or update an batch of OpptyProductRelationRevenueSchedules", "operationId": "OpptyProductRelationRevenueSchedules.batch_create_or_update", "summary": "OpptyProductRelationRevenueSchedules.batch_create_or_update", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelationRevenueSchedules on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpptyProductRelationRevenueSchedules. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OpptyProductRelationRevenueSchedule", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchOpptyProductRelationRevenueScheduleInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated OpptyProductRelationRevenueSchedules", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyProductRelationRevenueSchedules/batch-restore": {"post": {"description": "Restores OpptyProductRelationRevenueSchedules with given list of ids", "operationId": "OpptyProductRelationRevenueSchedules.batch_restore", "summary": "OpptyProductRelationRevenueSchedules.batch_restore", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelationRevenueSchedules on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpptyProductRelationRevenueSchedules. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OpptyProductRelationRevenueSchedule to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored OpptyProductRelationRevenueSchedule.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyProductRelationRevenueSchedulePeriods/{id}": {"get": {"description": "Returns OpptyProductRelationRevenueSchedulePeriod with given id", "operationId": "OpptyProductRelationRevenueSchedulePeriods.get", "summary": "OpptyProductRelationRevenueSchedulePeriods.get", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of OpptyProductRelationRevenueSchedulePeriod to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OpptyProductRelationRevenueSchedulePeriod data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpptyProductRelationRevenueSchedulePeriod"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes OpptyProductRelationRevenueSchedulePeriod with given id", "operationId": "OpptyProductRelationRevenueSchedulePeriods.delete", "summary": "OpptyProductRelationRevenueSchedulePeriods.delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of OpptyProductRelationRevenueSchedulePeriod to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelationRevenueSchedulePeriod on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted OpptyProductRelationRevenueSchedulePeriod", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies OpptyProductRelationRevenueSchedulePeriod or OpptyProductRelationRevenueSchedulePeriods with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of OpptyProductRelationRevenueSchedulePeriod to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelationRevenueSchedulePeriod on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "OpptyProductRelationRevenueSchedulePeriods.update", "summary": "OpptyProductRelationRevenueSchedulePeriods.update", "tags": ["Lead & Opportunity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateOpptyProductRelationRevenueSchedulePeriodInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting OpptyProductRelationRevenueSchedulePeriod", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpptyProductRelationRevenueSchedulePeriod"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyProductRelationRevenueSchedulePeriods": {"get": {"description": "Returns all defined OpptyProductRelationRevenueSchedulePeriods", "operationId": "OpptyProductRelationRevenueSchedulePeriods.list", "summary": "OpptyProductRelationRevenueSchedulePeriods.list", "tags": ["Lead & Opportunity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted OpptyProductRelationRevenueSchedulePeriods are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of OpptyProductRelationRevenueSchedulePeriods", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/OpptyProductRelationRevenueSchedulePeriod"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new OpptyProductRelationRevenueSchedulePeriod", "operationId": "OpptyProductRelationRevenueSchedulePeriods.create", "summary": "OpptyProductRelationRevenueSchedulePeriods.create", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelationRevenueSchedulePeriod on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OpptyProductRelationRevenueSchedulePeriod", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createOpptyProductRelationRevenueSchedulePeriodInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created OpptyProductRelationRevenueSchedulePeriod", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpptyProductRelationRevenueSchedulePeriod"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyProductRelationRevenueSchedulePeriods/batch-delete": {"post": {"description": "Removes OpptyProductRelationRevenueSchedulePeriods with given list of ids", "operationId": "OpptyProductRelationRevenueSchedulePeriods.batch_delete", "summary": "OpptyProductRelationRevenueSchedulePeriods.batch_delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelationRevenueSchedulePeriods on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpptyProductRelationRevenueSchedulePeriods. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OpptyProductRelationRevenueSchedulePeriod to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted OpptyProductRelationRevenueSchedulePeriod.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyProductRelationRevenueSchedulePeriods/batch-modify": {"post": {"description": "Create or update an batch of OpptyProductRelationRevenueSchedulePeriods", "operationId": "OpptyProductRelationRevenueSchedulePeriods.batch_create_or_update", "summary": "OpptyProductRelationRevenueSchedulePeriods.batch_create_or_update", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelationRevenueSchedulePeriods on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpptyProductRelationRevenueSchedulePeriods. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OpptyProductRelationRevenueSchedulePeriod", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchOpptyProductRelationRevenueSchedulePeriodInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated OpptyProductRelationRevenueSchedulePeriods", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyProductRelationRevenueSchedulePeriods/batch-restore": {"post": {"description": "Restores OpptyProductRelationRevenueSchedulePeriods with given list of ids", "operationId": "OpptyProductRelationRevenueSchedulePeriods.batch_restore", "summary": "OpptyProductRelationRevenueSchedulePeriods.batch_restore", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelationRevenueSchedulePeriods on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpptyProductRelationRevenueSchedulePeriods. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OpptyProductRelationRevenueSchedulePeriod to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored OpptyProductRelationRevenueSchedulePeriod.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyProductRelationTypes/{id}": {"get": {"description": "Returns OpptyProductRelationType with given id", "operationId": "OpptyProductRelationTypes.get", "summary": "OpptyProductRelationTypes.get", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of OpptyProductRelationType to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OpptyProductRelationType data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpptyProductRelationType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes OpptyProductRelationType with given id", "operationId": "OpptyProductRelationTypes.delete", "summary": "OpptyProductRelationTypes.delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of OpptyProductRelationType to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelationType on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted OpptyProductRelationType", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies OpptyProductRelationType or OpptyProductRelationTypes with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of OpptyProductRelationType to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelationType on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "OpptyProductRelationTypes.update", "summary": "OpptyProductRelationTypes.update", "tags": ["Lead & Opportunity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateOpptyProductRelationTypeInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting OpptyProductRelationType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpptyProductRelationType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyProductRelationTypes": {"get": {"description": "Returns all defined OpptyProductRelationTypes", "operationId": "OpptyProductRelationTypes.list", "summary": "OpptyProductRelationTypes.list", "tags": ["Lead & Opportunity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted OpptyProductRelationTypes are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of OpptyProductRelationTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/OpptyProductRelationType"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new OpptyProductRelationType", "operationId": "OpptyProductRelationTypes.create", "summary": "OpptyProductRelationTypes.create", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelationType on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OpptyProductRelationType", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createOpptyProductRelationTypeInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created OpptyProductRelationType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpptyProductRelationType"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyProductRelationTypes/batch-delete": {"post": {"description": "Removes OpptyProductRelationTypes with given list of ids", "operationId": "OpptyProductRelationTypes.batch_delete", "summary": "OpptyProductRelationTypes.batch_delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelationTypes on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpptyProductRelationTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OpptyProductRelationType to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted OpptyProductRelationType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyProductRelationTypes/batch-modify": {"post": {"description": "Create or update an batch of OpptyProductRelationTypes", "operationId": "OpptyProductRelationTypes.batch_create_or_update", "summary": "OpptyProductRelationTypes.batch_create_or_update", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelationTypes on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpptyProductRelationTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OpptyProductRelationType", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchOpptyProductRelationTypeInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated OpptyProductRelationTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyProductRelationTypes/batch-restore": {"post": {"description": "Restores OpptyProductRelationTypes with given list of ids", "operationId": "OpptyProductRelationTypes.batch_restore", "summary": "OpptyProductRelationTypes.batch_restore", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyProductRelationTypes on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpptyProductRelationTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OpptyProductRelationType to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored OpptyProductRelationType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyRecurrences/{id}": {"get": {"description": "Returns OpptyRecurrence with given id", "operationId": "OpptyRecurrences.get", "summary": "OpptyRecurrences.get", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of OpptyRecurrence to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OpptyRecurrence data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpptyRecurrence"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes OpptyRecurrence with given id", "operationId": "OpptyRecurrences.delete", "summary": "OpptyRecurrences.delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of OpptyRecurrence to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyRecurrence on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted OpptyRecurrence", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies OpptyRecurrence or OpptyRecurrences with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of OpptyRecurrence to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyRecurrence on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "OpptyRecurrences.update", "summary": "OpptyRecurrences.update", "tags": ["Lead & Opportunity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateOpptyRecurrenceInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting OpptyRecurrence", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpptyRecurrence"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyRecurrences": {"get": {"description": "Returns all defined OpptyRecurrences", "operationId": "OpptyRecurrences.list", "summary": "OpptyRecurrences.list", "tags": ["Lead & Opportunity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted OpptyRecurrences are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of OpptyRecurrences", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/OpptyRecurrence"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new OpptyRecurrence", "operationId": "OpptyRecurrences.create", "summary": "OpptyRecurrences.create", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyRecurrence on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OpptyRecurrence", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createOpptyRecurrenceInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created OpptyRecurrence", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpptyRecurrence"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyRecurrences/batch-delete": {"post": {"description": "Removes OpptyRecurrences with given list of ids", "operationId": "OpptyRecurrences.batch_delete", "summary": "OpptyRecurrences.batch_delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyRecurrences on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpptyRecurrences. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OpptyRecurrence to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted OpptyRecurrence.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyRecurrences/batch-modify": {"post": {"description": "Create or update an batch of OpptyRecurrences", "operationId": "OpptyRecurrences.batch_create_or_update", "summary": "OpptyRecurrences.batch_create_or_update", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyRecurrences on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpptyRecurrences. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OpptyRecurrence", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchOpptyRecurrenceInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated OpptyRecurrences", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyRecurrences/batch-restore": {"post": {"description": "Restores OpptyRecurrences with given list of ids", "operationId": "OpptyRecurrences.batch_restore", "summary": "OpptyRecurrences.batch_restore", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyRecurrences on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpptyRecurrences. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OpptyRecurrence to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored OpptyRecurrence.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyRevenueSchedules/{id}": {"get": {"description": "Returns OpptyRevenueSchedule with given id", "operationId": "OpptyRevenueSchedules.get", "summary": "OpptyRevenueSchedules.get", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of OpptyRevenueSchedule to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OpptyRevenueSchedule data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpptyRevenueSchedule"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes OpptyRevenueSchedule with given id", "operationId": "OpptyRevenueSchedules.delete", "summary": "OpptyRevenueSchedules.delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of OpptyRevenueSchedule to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyRevenueSchedule on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted OpptyRevenueSchedule", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies OpptyRevenueSchedule or OpptyRevenueSchedules with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of OpptyRevenueSchedule to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyRevenueSchedule on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "OpptyRevenueSchedules.update", "summary": "OpptyRevenueSchedules.update", "tags": ["Lead & Opportunity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateOpptyRevenueScheduleInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting OpptyRevenueSchedule", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpptyRevenueSchedule"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyRevenueSchedules": {"get": {"description": "Returns all defined OpptyRevenueSchedules", "operationId": "OpptyRevenueSchedules.list", "summary": "OpptyRevenueSchedules.list", "tags": ["Lead & Opportunity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted OpptyRevenueSchedules are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of OpptyRevenueSchedules", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/OpptyRevenueSchedule"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new OpptyRevenueSchedule", "operationId": "OpptyRevenueSchedules.create", "summary": "OpptyRevenueSchedules.create", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyRevenueSchedule on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OpptyRevenueSchedule", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createOpptyRevenueScheduleInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created OpptyRevenueSchedule", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpptyRevenueSchedule"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyRevenueSchedules/batch-delete": {"post": {"description": "Removes OpptyRevenueSchedules with given list of ids", "operationId": "OpptyRevenueSchedules.batch_delete", "summary": "OpptyRevenueSchedules.batch_delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyRevenueSchedules on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpptyRevenueSchedules. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OpptyRevenueSchedule to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted OpptyRevenueSchedule.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyRevenueSchedules/batch-modify": {"post": {"description": "Create or update an batch of OpptyRevenueSchedules", "operationId": "OpptyRevenueSchedules.batch_create_or_update", "summary": "OpptyRevenueSchedules.batch_create_or_update", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyRevenueSchedules on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpptyRevenueSchedules. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OpptyRevenueSchedule", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchOpptyRevenueScheduleInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated OpptyRevenueSchedules", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyRevenueSchedules/batch-restore": {"post": {"description": "Restores OpptyRevenueSchedules with given list of ids", "operationId": "OpptyRevenueSchedules.batch_restore", "summary": "OpptyRevenueSchedules.batch_restore", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyRevenueSchedules on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpptyRevenueSchedules. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OpptyRevenueSchedule to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored OpptyRevenueSchedule.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyRevenueSchedulePeriods/{id}": {"get": {"description": "Returns OpptyRevenueSchedulePeriod with given id", "operationId": "OpptyRevenueSchedulePeriods.get", "summary": "OpptyRevenueSchedulePeriods.get", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of OpptyRevenueSchedulePeriod to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OpptyRevenueSchedulePeriod data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpptyRevenueSchedulePeriod"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes OpptyRevenueSchedulePeriod with given id", "operationId": "OpptyRevenueSchedulePeriods.delete", "summary": "OpptyRevenueSchedulePeriods.delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "id", "in": "path", "description": "ID of OpptyRevenueSchedulePeriod to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyRevenueSchedulePeriod on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted OpptyRevenueSchedulePeriod", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies OpptyRevenueSchedulePeriod or OpptyRevenueSchedulePeriods with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of OpptyRevenueSchedulePeriod to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyRevenueSchedulePeriod on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "OpptyRevenueSchedulePeriods.update", "summary": "OpptyRevenueSchedulePeriods.update", "tags": ["Lead & Opportunity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateOpptyRevenueSchedulePeriodInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting OpptyRevenueSchedulePeriod", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpptyRevenueSchedulePeriod"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyRevenueSchedulePeriods": {"get": {"description": "Returns all defined OpptyRevenueSchedulePeriods", "operationId": "OpptyRevenueSchedulePeriods.list", "summary": "OpptyRevenueSchedulePeriods.list", "tags": ["Lead & Opportunity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted OpptyRevenueSchedulePeriods are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of OpptyRevenueSchedulePeriods", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/OpptyRevenueSchedulePeriod"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new OpptyRevenueSchedulePeriod", "operationId": "OpptyRevenueSchedulePeriods.create", "summary": "OpptyRevenueSchedulePeriods.create", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyRevenueSchedulePeriod on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OpptyRevenueSchedulePeriod", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createOpptyRevenueSchedulePeriodInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created OpptyRevenueSchedulePeriod", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/OpptyRevenueSchedulePeriod"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyRevenueSchedulePeriods/batch-delete": {"post": {"description": "Removes OpptyRevenueSchedulePeriods with given list of ids", "operationId": "OpptyRevenueSchedulePeriods.batch_delete", "summary": "OpptyRevenueSchedulePeriods.batch_delete", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyRevenueSchedulePeriods on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpptyRevenueSchedulePeriods. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OpptyRevenueSchedulePeriod to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted OpptyRevenueSchedulePeriod.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyRevenueSchedulePeriods/batch-modify": {"post": {"description": "Create or update an batch of OpptyRevenueSchedulePeriods", "operationId": "OpptyRevenueSchedulePeriods.batch_create_or_update", "summary": "OpptyRevenueSchedulePeriods.batch_create_or_update", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyRevenueSchedulePeriods on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpptyRevenueSchedulePeriods. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new OpptyRevenueSchedulePeriod", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchOpptyRevenueSchedulePeriodInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated OpptyRevenueSchedulePeriods", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/OpptyRevenueSchedulePeriods/batch-restore": {"post": {"description": "Restores OpptyRevenueSchedulePeriods with given list of ids", "operationId": "OpptyRevenueSchedulePeriods.batch_restore", "summary": "OpptyRevenueSchedulePeriods.batch_restore", "tags": ["Lead & Opportunity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of OpptyRevenueSchedulePeriods on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for OpptyRevenueSchedulePeriods. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity OpptyRevenueSchedulePeriod to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored OpptyRevenueSchedulePeriod.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ParentAccountRelationTypes/{id}": {"get": {"description": "Returns ParentAccountRelationType with given id", "operationId": "ParentAccountRelationTypes.get", "summary": "ParentAccountRelationTypes.get", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of ParentAccountRelationType to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ParentAccountRelationType data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ParentAccountRelationType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ParentAccountRelationType with given id", "operationId": "ParentAccountRelationTypes.delete", "summary": "ParentAccountRelationTypes.delete", "tags": ["Account"], "parameters": [{"name": "id", "in": "path", "description": "ID of ParentAccountRelationType to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ParentAccountRelationType on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ParentAccountRelationType", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ParentAccountRelationType or ParentAccountRelationTypes with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ParentAccountRelationType to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ParentAccountRelationType on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ParentAccountRelationTypes.update", "summary": "ParentAccountRelationTypes.update", "tags": ["Account"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateParentAccountRelationTypeInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ParentAccountRelationType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ParentAccountRelationType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ParentAccountRelationTypes": {"get": {"description": "Returns all defined ParentAccountRelationTypes", "operationId": "ParentAccountRelationTypes.list", "summary": "ParentAccountRelationTypes.list", "tags": ["Account"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ParentAccountRelationTypes are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ParentAccountRelationTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ParentAccountRelationType"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ParentAccountRelationType", "operationId": "ParentAccountRelationTypes.create", "summary": "ParentAccountRelationTypes.create", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ParentAccountRelationType on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ParentAccountRelationType", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createParentAccountRelationTypeInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ParentAccountRelationType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ParentAccountRelationType"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ParentAccountRelationTypes/batch-delete": {"post": {"description": "Removes ParentAccountRelationTypes with given list of ids", "operationId": "ParentAccountRelationTypes.batch_delete", "summary": "ParentAccountRelationTypes.batch_delete", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ParentAccountRelationTypes on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ParentAccountRelationTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ParentAccountRelationType to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ParentAccountRelationType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ParentAccountRelationTypes/batch-modify": {"post": {"description": "Create or update an batch of ParentAccountRelationTypes", "operationId": "ParentAccountRelationTypes.batch_create_or_update", "summary": "ParentAccountRelationTypes.batch_create_or_update", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ParentAccountRelationTypes on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ParentAccountRelationTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ParentAccountRelationType", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchParentAccountRelationTypeInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ParentAccountRelationTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ParentAccountRelationTypes/batch-restore": {"post": {"description": "Restores ParentAccountRelationTypes with given list of ids", "operationId": "ParentAccountRelationTypes.batch_restore", "summary": "ParentAccountRelationTypes.batch_restore", "tags": ["Account"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ParentAccountRelationTypes on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ParentAccountRelationTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ParentAccountRelationType to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ParentAccountRelationType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Phones/{id}": {"get": {"description": "Returns Phone with given id", "operationId": "Phones.get", "summary": "Phones.get", "tags": ["Phone"], "parameters": [{"name": "id", "in": "path", "description": "ID of Phone to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Phone data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Phone"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Phone with given id", "operationId": "Phones.delete", "summary": "Phones.delete", "tags": ["Phone"], "parameters": [{"name": "id", "in": "path", "description": "ID of Phone to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Phone on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Phone", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Phone or Phones with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Phone to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Phone on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Phones.update", "summary": "Phones.update", "tags": ["Phone"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updatePhoneInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Phone", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Phone"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Phones": {"get": {"description": "Returns all defined Phones", "operationId": "Phones.list", "summary": "Phones.list", "tags": ["Phone"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Phones are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Phones", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Phone"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Phone", "operationId": "Phones.create", "summary": "Phones.create", "tags": ["Phone"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Phone on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Phone", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createPhoneInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Phone", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Phone"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Phones/batch-delete": {"post": {"description": "Removes Phones with given list of ids", "operationId": "Phones.batch_delete", "summary": "Phones.batch_delete", "tags": ["Phone"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Phones on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Phones. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Phone to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Phone.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Phones/batch-modify": {"post": {"description": "Create or update an batch of Phones", "operationId": "Phones.batch_create_or_update", "summary": "Phones.batch_create_or_update", "tags": ["Phone"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Phones on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Phones. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Phone", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchPhoneInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Phones", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Phones/batch-restore": {"post": {"description": "Restores Phones with given list of ids", "operationId": "Phones.batch_restore", "summary": "Phones.batch_restore", "tags": ["Phone"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Phones on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Phones. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Phone to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Phone.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Pipelines/{id}": {"get": {"description": "Returns Pipeline with given id", "operationId": "Pipelines.get", "summary": "Pipelines.get", "tags": ["Pipeline"], "parameters": [{"name": "id", "in": "path", "description": "ID of Pipeline to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Pipeline data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Pipeline"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Pipeline with given id", "operationId": "Pipelines.delete", "summary": "Pipelines.delete", "tags": ["Pipeline"], "parameters": [{"name": "id", "in": "path", "description": "ID of Pipeline to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Pipeline on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Pipeline", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Pipeline or Pipelines with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Pipeline to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Pipeline on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Pipelines.update", "summary": "Pipelines.update", "tags": ["Pipeline"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updatePipelineInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Pipeline", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Pipeline"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Pipelines": {"get": {"description": "Returns all defined Pipelines", "operationId": "Pipelines.list", "summary": "Pipelines.list", "tags": ["Pipeline"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Pipelines are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Pipelines", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Pipeline"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Pipeline", "operationId": "Pipelines.create", "summary": "Pipelines.create", "tags": ["Pipeline"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Pipeline on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Pipeline", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createPipelineInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Pipeline", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Pipeline"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Pipelines/batch-delete": {"post": {"description": "Removes Pipelines with given list of ids", "operationId": "Pipelines.batch_delete", "summary": "Pipelines.batch_delete", "tags": ["Pipeline"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Pipelines on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Pipelines. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Pipeline to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Pipeline.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Pipelines/batch-modify": {"post": {"description": "Create or update an batch of Pipelines", "operationId": "Pipelines.batch_create_or_update", "summary": "Pipelines.batch_create_or_update", "tags": ["Pipeline"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Pipelines on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Pipelines. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Pipeline", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchPipelineInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Pipelines", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Pipelines/batch-restore": {"post": {"description": "Restores Pipelines with given list of ids", "operationId": "Pipelines.batch_restore", "summary": "Pipelines.batch_restore", "tags": ["Pipeline"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Pipelines on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Pipelines. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Pipeline to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Pipeline.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Processes/{id}": {"get": {"description": "Returns Process with given id", "operationId": "Processes.get", "summary": "Processes.get", "tags": ["Process"], "parameters": [{"name": "id", "in": "path", "description": "ID of Process to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Process data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Process"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Process with given id", "operationId": "Processes.delete", "summary": "Processes.delete", "tags": ["Process"], "parameters": [{"name": "id", "in": "path", "description": "ID of Process to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Process on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Process", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Process or Processes with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Process to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Process on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Processes.update", "summary": "Processes.update", "tags": ["Process"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateProcessInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Process", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Process"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Processes": {"get": {"description": "Returns all defined Processes", "operationId": "Processes.list", "summary": "Processes.list", "tags": ["Process"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Processes are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Processes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Process"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Process", "operationId": "Processes.create", "summary": "Processes.create", "tags": ["Process"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Process on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Process", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createProcessInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Process", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Process"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Processes/batch-delete": {"post": {"description": "Removes Processes with given list of ids", "operationId": "Processes.batch_delete", "summary": "Processes.batch_delete", "tags": ["Process"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Processes on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Processes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Process to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Process.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Processes/batch-modify": {"post": {"description": "Create or update an batch of Processes", "operationId": "Processes.batch_create_or_update", "summary": "Processes.batch_create_or_update", "tags": ["Process"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Processes on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Processes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Process", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchProcessInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Processes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Processes/batch-restore": {"post": {"description": "Restores Processes with given list of ids", "operationId": "Processes.batch_restore", "summary": "Processes.batch_restore", "tags": ["Process"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Processes on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Processes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Process to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Process.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProcessActivityLogs/{id}": {"get": {"description": "Returns ProcessActivityLog with given id", "operationId": "ProcessActivityLogs.get", "summary": "ProcessActivityLogs.get", "tags": ["Process"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProcessActivityLog to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ProcessActivityLog data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProcessActivityLog"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ProcessActivityLog with given id", "operationId": "ProcessActivityLogs.delete", "summary": "ProcessActivityLogs.delete", "tags": ["Process"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProcessActivityLog to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProcessActivityLog on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ProcessActivityLog", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ProcessActivityLog or ProcessActivityLogs with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ProcessActivityLog to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProcessActivityLog on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ProcessActivityLogs.update", "summary": "ProcessActivityLogs.update", "tags": ["Process"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateProcessActivityLogInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ProcessActivityLog", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProcessActivityLog"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProcessActivityLogs": {"get": {"description": "Returns all defined ProcessActivityLogs", "operationId": "ProcessActivityLogs.list", "summary": "ProcessActivityLogs.list", "tags": ["Process"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ProcessActivityLogs are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ProcessActivityLogs", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ProcessActivityLog"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ProcessActivityLog", "operationId": "ProcessActivityLogs.create", "summary": "ProcessActivityLogs.create", "tags": ["Process"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProcessActivityLog on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProcessActivityLog", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createProcessActivityLogInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ProcessActivityLog", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProcessActivityLog"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProcessActivityLogs/batch-delete": {"post": {"description": "Removes ProcessActivityLogs with given list of ids", "operationId": "ProcessActivityLogs.batch_delete", "summary": "ProcessActivityLogs.batch_delete", "tags": ["Process"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProcessActivityLogs on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProcessActivityLogs. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProcessActivityLog to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ProcessActivityLog.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProcessActivityLogs/batch-modify": {"post": {"description": "Create or update an batch of ProcessActivityLogs", "operationId": "ProcessActivityLogs.batch_create_or_update", "summary": "ProcessActivityLogs.batch_create_or_update", "tags": ["Process"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProcessActivityLogs on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProcessActivityLogs. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProcessActivityLog", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchProcessActivityLogInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ProcessActivityLogs", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProcessActivityLogs/batch-restore": {"post": {"description": "Restores ProcessActivityLogs with given list of ids", "operationId": "ProcessActivityLogs.batch_restore", "summary": "ProcessActivityLogs.batch_restore", "tags": ["Process"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProcessActivityLogs on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProcessActivityLogs. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProcessActivityLog to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ProcessActivityLog.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProcessActivityLogLines/{id}": {"get": {"description": "Returns ProcessActivityLogLine with given id", "operationId": "ProcessActivityLogLines.get", "summary": "ProcessActivityLogLines.get", "tags": ["Process"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProcessActivityLogLine to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ProcessActivityLogLine data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProcessActivityLogLine"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ProcessActivityLogLine with given id", "operationId": "ProcessActivityLogLines.delete", "summary": "ProcessActivityLogLines.delete", "tags": ["Process"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProcessActivityLogLine to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProcessActivityLogLine on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ProcessActivityLogLine", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ProcessActivityLogLine or ProcessActivityLogLines with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ProcessActivityLogLine to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProcessActivityLogLine on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ProcessActivityLogLines.update", "summary": "ProcessActivityLogLines.update", "tags": ["Process"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateProcessActivityLogLineInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ProcessActivityLogLine", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProcessActivityLogLine"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProcessActivityLogLines": {"get": {"description": "Returns all defined ProcessActivityLogLines", "operationId": "ProcessActivityLogLines.list", "summary": "ProcessActivityLogLines.list", "tags": ["Process"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ProcessActivityLogLines are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ProcessActivityLogLines", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ProcessActivityLogLine"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ProcessActivityLogLine", "operationId": "ProcessActivityLogLines.create", "summary": "ProcessActivityLogLines.create", "tags": ["Process"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProcessActivityLogLine on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProcessActivityLogLine", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createProcessActivityLogLineInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ProcessActivityLogLine", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProcessActivityLogLine"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProcessActivityLogLines/batch-delete": {"post": {"description": "Removes ProcessActivityLogLines with given list of ids", "operationId": "ProcessActivityLogLines.batch_delete", "summary": "ProcessActivityLogLines.batch_delete", "tags": ["Process"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProcessActivityLogLines on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProcessActivityLogLines. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProcessActivityLogLine to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ProcessActivityLogLine.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProcessActivityLogLines/batch-modify": {"post": {"description": "Create or update an batch of ProcessActivityLogLines", "operationId": "ProcessActivityLogLines.batch_create_or_update", "summary": "ProcessActivityLogLines.batch_create_or_update", "tags": ["Process"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProcessActivityLogLines on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProcessActivityLogLines. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProcessActivityLogLine", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchProcessActivityLogLineInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ProcessActivityLogLines", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProcessActivityLogLines/batch-restore": {"post": {"description": "Restores ProcessActivityLogLines with given list of ids", "operationId": "ProcessActivityLogLines.batch_restore", "summary": "ProcessActivityLogLines.batch_restore", "tags": ["Process"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProcessActivityLogLines on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProcessActivityLogLines. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProcessActivityLogLine to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ProcessActivityLogLine.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProcessTemplates/{id}": {"get": {"description": "Returns ProcessTemplate with given id", "operationId": "ProcessTemplates.get", "summary": "ProcessTemplates.get", "tags": ["Process"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProcessTemplate to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ProcessTemplate data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProcessTemplate"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ProcessTemplate with given id", "operationId": "ProcessTemplates.delete", "summary": "ProcessTemplates.delete", "tags": ["Process"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProcessTemplate to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProcessTemplate on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ProcessTemplate", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ProcessTemplate or ProcessTemplates with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ProcessTemplate to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProcessTemplate on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ProcessTemplates.update", "summary": "ProcessTemplates.update", "tags": ["Process"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateProcessTemplateInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ProcessTemplate", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProcessTemplate"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProcessTemplates": {"get": {"description": "Returns all defined ProcessTemplates", "operationId": "ProcessTemplates.list", "summary": "ProcessTemplates.list", "tags": ["Process"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ProcessTemplates are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ProcessTemplates", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ProcessTemplate"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ProcessTemplate", "operationId": "ProcessTemplates.create", "summary": "ProcessTemplates.create", "tags": ["Process"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProcessTemplate on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProcessTemplate", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createProcessTemplateInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ProcessTemplate", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProcessTemplate"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProcessTemplates/batch-delete": {"post": {"description": "Removes ProcessTemplates with given list of ids", "operationId": "ProcessTemplates.batch_delete", "summary": "ProcessTemplates.batch_delete", "tags": ["Process"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProcessTemplates on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProcessTemplates. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProcessTemplate to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ProcessTemplate.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProcessTemplates/batch-modify": {"post": {"description": "Create or update an batch of ProcessTemplates", "operationId": "ProcessTemplates.batch_create_or_update", "summary": "ProcessTemplates.batch_create_or_update", "tags": ["Process"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProcessTemplates on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProcessTemplates. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProcessTemplate", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchProcessTemplateInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ProcessTemplates", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProcessTemplates/batch-restore": {"post": {"description": "Restores ProcessTemplates with given list of ids", "operationId": "ProcessTemplates.batch_restore", "summary": "ProcessTemplates.batch_restore", "tags": ["Process"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProcessTemplates on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProcessTemplates. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProcessTemplate to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ProcessTemplate.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Products/{id}": {"get": {"description": "Returns Product with given id", "operationId": "Products.get", "summary": "Products.get", "tags": ["Product"], "parameters": [{"name": "id", "in": "path", "description": "ID of Product to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Product data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Product"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Product with given id", "operationId": "Products.delete", "summary": "Products.delete", "tags": ["Product"], "parameters": [{"name": "id", "in": "path", "description": "ID of Product to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Product on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Product", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Product or Products with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Product to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Product on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Products.update", "summary": "Products.update", "tags": ["Product"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateProductInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Product", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Product"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Products": {"get": {"description": "Returns all defined Products", "operationId": "Products.list", "summary": "Products.list", "tags": ["Product"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Products are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Products", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Product"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Product", "operationId": "Products.create", "summary": "Products.create", "tags": ["Product"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Product on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Product", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createProductInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Product", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Product"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Products/batch-delete": {"post": {"description": "Removes Products with given list of ids", "operationId": "Products.batch_delete", "summary": "Products.batch_delete", "tags": ["Product"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Products on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Products. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Product to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Product.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Products/batch-modify": {"post": {"description": "Create or update an batch of Products", "operationId": "Products.batch_create_or_update", "summary": "Products.batch_create_or_update", "tags": ["Product"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Products on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Products. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Product", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchProductInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Products", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Products/batch-restore": {"post": {"description": "Restores Products with given list of ids", "operationId": "Products.batch_restore", "summary": "Products.batch_restore", "tags": ["Product"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Products on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Products. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Product to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Product.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductCategories/{id}": {"get": {"description": "Returns ProductCategory with given id", "operationId": "ProductCategories.get", "summary": "ProductCategories.get", "tags": ["Product"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProductCategory to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ProductCategory data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProductCategory"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ProductCategory with given id", "operationId": "ProductCategories.delete", "summary": "ProductCategories.delete", "tags": ["Product"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProductCategory to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProductCategory on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ProductCategory", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ProductCategory or ProductCategories with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ProductCategory to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProductCategory on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ProductCategories.update", "summary": "ProductCategories.update", "tags": ["Product"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateProductCategoryInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ProductCategory", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProductCategory"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductCategories": {"get": {"description": "Returns all defined ProductCategories", "operationId": "ProductCategories.list", "summary": "ProductCategories.list", "tags": ["Product"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ProductCategories are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ProductCategories", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ProductCategory"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ProductCategory", "operationId": "ProductCategories.create", "summary": "ProductCategories.create", "tags": ["Product"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProductCategory on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProductCategory", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createProductCategoryInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ProductCategory", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProductCategory"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductCategories/batch-delete": {"post": {"description": "Removes ProductCategories with given list of ids", "operationId": "ProductCategories.batch_delete", "summary": "ProductCategories.batch_delete", "tags": ["Product"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProductCategories on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProductCategories. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProductCategory to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ProductCategory.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductCategories/batch-modify": {"post": {"description": "Create or update an batch of ProductCategories", "operationId": "ProductCategories.batch_create_or_update", "summary": "ProductCategories.batch_create_or_update", "tags": ["Product"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProductCategories on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProductCategories. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProductCategory", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchProductCategoryInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ProductCategories", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductCategories/batch-restore": {"post": {"description": "Restores ProductCategories with given list of ids", "operationId": "ProductCategories.batch_restore", "summary": "ProductCategories.batch_restore", "tags": ["Product"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProductCategories on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProductCategories. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProductCategory to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ProductCategory.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductDataExRelations/{id}": {"get": {"description": "Returns ProductDataExRelation with given id", "operationId": "ProductDataExRelations.get", "summary": "ProductDataExRelations.get", "tags": ["Product"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProductDataExRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ProductDataExRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProductDataExRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductDataExRelations": {"get": {"description": "Returns all defined ProductDataExRelations", "operationId": "ProductDataExRelations.list", "summary": "ProductDataExRelations.list", "tags": ["Product"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ProductDataExRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ProductDataExRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ProductDataExRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductPipelineRelations/{id}": {"get": {"description": "Returns ProductPipelineRelation with given id", "operationId": "ProductPipelineRelations.get", "summary": "ProductPipelineRelations.get", "tags": ["Product"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProductPipelineRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ProductPipelineRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProductPipelineRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ProductPipelineRelation with given id", "operationId": "ProductPipelineRelations.delete", "summary": "ProductPipelineRelations.delete", "tags": ["Product"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProductPipelineRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProductPipelineRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ProductPipelineRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ProductPipelineRelation or ProductPipelineRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ProductPipelineRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProductPipelineRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ProductPipelineRelations.update", "summary": "ProductPipelineRelations.update", "tags": ["Product"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateProductPipelineRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ProductPipelineRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProductPipelineRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductPipelineRelations": {"get": {"description": "Returns all defined ProductPipelineRelations", "operationId": "ProductPipelineRelations.list", "summary": "ProductPipelineRelations.list", "tags": ["Product"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ProductPipelineRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ProductPipelineRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ProductPipelineRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ProductPipelineRelation", "operationId": "ProductPipelineRelations.create", "summary": "ProductPipelineRelations.create", "tags": ["Product"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProductPipelineRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProductPipelineRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createProductPipelineRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ProductPipelineRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProductPipelineRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductPipelineRelations/batch-delete": {"post": {"description": "Removes ProductPipelineRelations with given list of ids", "operationId": "ProductPipelineRelations.batch_delete", "summary": "ProductPipelineRelations.batch_delete", "tags": ["Product"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProductPipelineRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProductPipelineRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProductPipelineRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ProductPipelineRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductPipelineRelations/batch-modify": {"post": {"description": "Create or update an batch of ProductPipelineRelations", "operationId": "ProductPipelineRelations.batch_create_or_update", "summary": "ProductPipelineRelations.batch_create_or_update", "tags": ["Product"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProductPipelineRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProductPipelineRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProductPipelineRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchProductPipelineRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ProductPipelineRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductPipelineRelations/batch-restore": {"post": {"description": "Restores ProductPipelineRelations with given list of ids", "operationId": "ProductPipelineRelations.batch_restore", "summary": "ProductPipelineRelations.batch_restore", "tags": ["Product"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProductPipelineRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProductPipelineRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProductPipelineRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ProductPipelineRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductPriceLists/{id}": {"get": {"description": "Returns ProductPriceList with given id", "operationId": "ProductPriceLists.get", "summary": "ProductPriceLists.get", "tags": ["Product"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProductPriceList to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ProductPriceList data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProductPriceList"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ProductPriceList with given id", "operationId": "ProductPriceLists.delete", "summary": "ProductPriceLists.delete", "tags": ["Product"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProductPriceList to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProductPriceList on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ProductPriceList", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ProductPriceList or ProductPriceLists with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ProductPriceList to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProductPriceList on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ProductPriceLists.update", "summary": "ProductPriceLists.update", "tags": ["Product"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateProductPriceListInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ProductPriceList", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProductPriceList"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductPriceLists": {"get": {"description": "Returns all defined ProductPriceLists", "operationId": "ProductPriceLists.list", "summary": "ProductPriceLists.list", "tags": ["Product"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ProductPriceLists are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ProductPriceLists", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ProductPriceList"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ProductPriceList", "operationId": "ProductPriceLists.create", "summary": "ProductPriceLists.create", "tags": ["Product"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProductPriceList on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProductPriceList", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createProductPriceListInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ProductPriceList", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProductPriceList"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductPriceLists/batch-delete": {"post": {"description": "Removes ProductPriceLists with given list of ids", "operationId": "ProductPriceLists.batch_delete", "summary": "ProductPriceLists.batch_delete", "tags": ["Product"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProductPriceLists on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProductPriceLists. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProductPriceList to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ProductPriceList.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductPriceLists/batch-modify": {"post": {"description": "Create or update an batch of ProductPriceLists", "operationId": "ProductPriceLists.batch_create_or_update", "summary": "ProductPriceLists.batch_create_or_update", "tags": ["Product"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProductPriceLists on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProductPriceLists. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProductPriceList", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchProductPriceListInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ProductPriceLists", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductPriceLists/batch-restore": {"post": {"description": "Restores ProductPriceLists with given list of ids", "operationId": "ProductPriceLists.batch_restore", "summary": "ProductPriceLists.batch_restore", "tags": ["Product"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProductPriceLists on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProductPriceLists. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProductPriceList to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ProductPriceList.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductPriceListPrices/{id}": {"get": {"description": "Returns ProductPriceListPrice with given id", "operationId": "ProductPriceListPrices.get", "summary": "ProductPriceListPrices.get", "tags": ["Product"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProductPriceListPrice to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ProductPriceListPrice data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProductPriceListPrice"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ProductPriceListPrice with given id", "operationId": "ProductPriceListPrices.delete", "summary": "ProductPriceListPrices.delete", "tags": ["Product"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProductPriceListPrice to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProductPriceListPrice on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ProductPriceListPrice", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ProductPriceListPrice or ProductPriceListPrices with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ProductPriceListPrice to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProductPriceListPrice on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ProductPriceListPrices.update", "summary": "ProductPriceListPrices.update", "tags": ["Product"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateProductPriceListPriceInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ProductPriceListPrice", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProductPriceListPrice"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductPriceListPrices": {"get": {"description": "Returns all defined ProductPriceListPrices", "operationId": "ProductPriceListPrices.list", "summary": "ProductPriceListPrices.list", "tags": ["Product"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ProductPriceListPrices are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ProductPriceListPrices", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ProductPriceListPrice"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ProductPriceListPrice", "operationId": "ProductPriceListPrices.create", "summary": "ProductPriceListPrices.create", "tags": ["Product"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProductPriceListPrice on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProductPriceListPrice", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createProductPriceListPriceInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ProductPriceListPrice", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProductPriceListPrice"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductPriceListPrices/batch-delete": {"post": {"description": "Removes ProductPriceListPrices with given list of ids", "operationId": "ProductPriceListPrices.batch_delete", "summary": "ProductPriceListPrices.batch_delete", "tags": ["Product"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProductPriceListPrices on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProductPriceListPrices. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProductPriceListPrice to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ProductPriceListPrice.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductPriceListPrices/batch-modify": {"post": {"description": "Create or update an batch of ProductPriceListPrices", "operationId": "ProductPriceListPrices.batch_create_or_update", "summary": "ProductPriceListPrices.batch_create_or_update", "tags": ["Product"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProductPriceListPrices on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProductPriceListPrices. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProductPriceListPrice", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchProductPriceListPriceInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ProductPriceListPrices", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductPriceListPrices/batch-restore": {"post": {"description": "Restores ProductPriceListPrices with given list of ids", "operationId": "ProductPriceListPrices.batch_restore", "summary": "ProductPriceListPrices.batch_restore", "tags": ["Product"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProductPriceListPrices on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProductPriceListPrices. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProductPriceListPrice to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ProductPriceListPrice.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductTypes/{id}": {"get": {"description": "Returns ProductType with given id", "operationId": "ProductTypes.get", "summary": "ProductTypes.get", "tags": ["Product"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProductType to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ProductType data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProductType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ProductType with given id", "operationId": "ProductTypes.delete", "summary": "ProductTypes.delete", "tags": ["Product"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProductType to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProductType on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ProductType", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ProductType or ProductTypes with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ProductType to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProductType on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ProductTypes.update", "summary": "ProductTypes.update", "tags": ["Product"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateProductTypeInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ProductType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProductType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductTypes": {"get": {"description": "Returns all defined ProductTypes", "operationId": "ProductTypes.list", "summary": "ProductTypes.list", "tags": ["Product"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ProductTypes are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ProductTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ProductType"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ProductType", "operationId": "ProductTypes.create", "summary": "ProductTypes.create", "tags": ["Product"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProductType on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProductType", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createProductTypeInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ProductType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProductType"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductTypes/batch-delete": {"post": {"description": "Removes ProductTypes with given list of ids", "operationId": "ProductTypes.batch_delete", "summary": "ProductTypes.batch_delete", "tags": ["Product"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProductTypes on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProductTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProductType to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ProductType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductTypes/batch-modify": {"post": {"description": "Create or update an batch of ProductTypes", "operationId": "ProductTypes.batch_create_or_update", "summary": "ProductTypes.batch_create_or_update", "tags": ["Product"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProductTypes on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProductTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProductType", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchProductTypeInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ProductTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProductTypes/batch-restore": {"post": {"description": "Restores ProductTypes with given list of ids", "operationId": "ProductTypes.batch_restore", "summary": "ProductTypes.batch_restore", "tags": ["Product"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProductTypes on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProductTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProductType to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ProductType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Profiles/{id}": {"get": {"description": "Returns Profile with given id", "operationId": "Profiles.get", "summary": "Profiles.get", "tags": ["Profile"], "parameters": [{"name": "id", "in": "path", "description": "ID of Profile to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Profile data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Profile"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Profiles": {"get": {"description": "Returns all defined Profiles", "operationId": "Profiles.list", "summary": "Profiles.list", "tags": ["Profile"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Profiles are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Profiles", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Profile"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProfileRelations/{id}": {"get": {"description": "Returns ProfileRelation with given id", "operationId": "ProfileRelations.get", "summary": "ProfileRelations.get", "tags": ["Profile"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProfileRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ProfileRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProfileRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ProfileRelation with given id", "operationId": "ProfileRelations.delete", "summary": "ProfileRelations.delete", "tags": ["Profile"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProfileRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProfileRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ProfileRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ProfileRelation or ProfileRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ProfileRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProfileRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ProfileRelations.update", "summary": "ProfileRelations.update", "tags": ["Profile"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateProfileRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ProfileRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProfileRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProfileRelations": {"get": {"description": "Returns all defined ProfileRelations", "operationId": "ProfileRelations.list", "summary": "ProfileRelations.list", "tags": ["Profile"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ProfileRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ProfileRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ProfileRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ProfileRelation", "operationId": "ProfileRelations.create", "summary": "ProfileRelations.create", "tags": ["Profile"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProfileRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProfileRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createProfileRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ProfileRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProfileRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProfileRelations/batch-delete": {"post": {"description": "Removes ProfileRelations with given list of ids", "operationId": "ProfileRelations.batch_delete", "summary": "ProfileRelations.batch_delete", "tags": ["Profile"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProfileRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProfileRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProfileRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ProfileRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProfileRelations/batch-modify": {"post": {"description": "Create or update an batch of ProfileRelations", "operationId": "ProfileRelations.batch_create_or_update", "summary": "ProfileRelations.batch_create_or_update", "tags": ["Profile"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProfileRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProfileRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProfileRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchProfileRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ProfileRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProfileRelations/batch-restore": {"post": {"description": "Restores ProfileRelations with given list of ids", "operationId": "ProfileRelations.batch_restore", "summary": "ProfileRelations.batch_restore", "tags": ["Profile"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProfileRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProfileRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProfileRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ProfileRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProfileSharingClientRelations/{id}": {"get": {"description": "Returns ProfileSharingClientRelation with given id", "operationId": "ProfileSharingClientRelations.get", "summary": "ProfileSharingClientRelations.get", "tags": ["Profile"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProfileSharingClientRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ProfileSharingClientRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProfileSharingClientRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProfileSharingClientRelations": {"get": {"description": "Returns all defined ProfileSharingClientRelations", "operationId": "ProfileSharingClientRelations.list", "summary": "ProfileSharingClientRelations.list", "tags": ["Profile"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ProfileSharingClientRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ProfileSharingClientRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ProfileSharingClientRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProfileSharingSalesUnitRelations/{id}": {"get": {"description": "Returns ProfileSharingSalesUnitRelation with given id", "operationId": "ProfileSharingSalesUnitRelations.get", "summary": "ProfileSharingSalesUnitRelations.get", "tags": ["Profile"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProfileSharingSalesUnitRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ProfileSharingSalesUnitRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProfileSharingSalesUnitRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProfileSharingSalesUnitRelations": {"get": {"description": "Returns all defined ProfileSharingSalesUnitRelations", "operationId": "ProfileSharingSalesUnitRelations.list", "summary": "ProfileSharingSalesUnitRelations.list", "tags": ["Profile"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ProfileSharingSalesUnitRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ProfileSharingSalesUnitRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ProfileSharingSalesUnitRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Projects/{id}": {"get": {"description": "Returns Project with given id", "operationId": "Projects.get", "summary": "Projects.get", "tags": ["Project"], "parameters": [{"name": "id", "in": "path", "description": "ID of Project to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Project data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Project"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Project with given id", "operationId": "Projects.delete", "summary": "Projects.delete", "tags": ["Project"], "parameters": [{"name": "id", "in": "path", "description": "ID of Project to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Project on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Project", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Project or Projects with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Project to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Project on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Projects.update", "summary": "Projects.update", "tags": ["Project"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateProjectInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Project", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Project"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Projects": {"get": {"description": "Returns all defined Projects", "operationId": "Projects.list", "summary": "Projects.list", "tags": ["Project"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Projects are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Projects", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Project"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Project", "operationId": "Projects.create", "summary": "Projects.create", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Project on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Project", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createProjectInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Project", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Project"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Projects/batch-delete": {"post": {"description": "Removes Projects with given list of ids", "operationId": "Projects.batch_delete", "summary": "Projects.batch_delete", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Projects on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Projects. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Project to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Project.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Projects/batch-modify": {"post": {"description": "Create or update an batch of Projects", "operationId": "Projects.batch_create_or_update", "summary": "Projects.batch_create_or_update", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Projects on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Projects. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Project", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchProjectInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Projects", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Projects/batch-restore": {"post": {"description": "Restores Projects with given list of ids", "operationId": "Projects.batch_restore", "summary": "Projects.batch_restore", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Projects on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Projects. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Project to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Project.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectContactRelations/{id}": {"get": {"description": "Returns ProjectContactRelation with given id", "operationId": "ProjectContactRelations.get", "summary": "ProjectContactRelations.get", "tags": ["Project"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProjectContactRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ProjectContactRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProjectContactRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ProjectContactRelation with given id", "operationId": "ProjectContactRelations.delete", "summary": "ProjectContactRelations.delete", "tags": ["Project"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProjectContactRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectContactRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ProjectContactRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ProjectContactRelation or ProjectContactRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ProjectContactRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectContactRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ProjectContactRelations.update", "summary": "ProjectContactRelations.update", "tags": ["Project"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateProjectContactRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ProjectContactRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProjectContactRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectContactRelations": {"get": {"description": "Returns all defined ProjectContactRelations", "operationId": "ProjectContactRelations.list", "summary": "ProjectContactRelations.list", "tags": ["Project"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ProjectContactRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ProjectContactRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ProjectContactRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ProjectContactRelation", "operationId": "ProjectContactRelations.create", "summary": "ProjectContactRelations.create", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectContactRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProjectContactRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createProjectContactRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ProjectContactRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProjectContactRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectContactRelations/batch-delete": {"post": {"description": "Removes ProjectContactRelations with given list of ids", "operationId": "ProjectContactRelations.batch_delete", "summary": "ProjectContactRelations.batch_delete", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectContactRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProjectContactRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProjectContactRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ProjectContactRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectContactRelations/batch-modify": {"post": {"description": "Create or update an batch of ProjectContactRelations", "operationId": "ProjectContactRelations.batch_create_or_update", "summary": "ProjectContactRelations.batch_create_or_update", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectContactRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProjectContactRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProjectContactRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchProjectContactRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ProjectContactRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectContactRelations/batch-restore": {"post": {"description": "Restores ProjectContactRelations with given list of ids", "operationId": "ProjectContactRelations.batch_restore", "summary": "ProjectContactRelations.batch_restore", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectContactRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProjectContactRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProjectContactRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ProjectContactRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectDataExRelations/{id}": {"get": {"description": "Returns ProjectDataExRelation with given id", "operationId": "ProjectDataExRelations.get", "summary": "ProjectDataExRelations.get", "tags": ["Project"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProjectDataExRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ProjectDataExRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProjectDataExRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectDataExRelations": {"get": {"description": "Returns all defined ProjectDataExRelations", "operationId": "ProjectDataExRelations.list", "summary": "ProjectDataExRelations.list", "tags": ["Project"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ProjectDataExRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ProjectDataExRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ProjectDataExRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectKPIs/{id}": {"get": {"description": "Returns ProjectKPI with given id", "operationId": "ProjectKPIs.get", "summary": "ProjectKPIs.get", "tags": ["Project"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProjectKPI to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ProjectKPI data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProjectKPI"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ProjectKPI with given id", "operationId": "ProjectKPIs.delete", "summary": "ProjectKPIs.delete", "tags": ["Project"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProjectKPI to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectKPI on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ProjectKPI", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ProjectKPI or ProjectKPIs with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ProjectKPI to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectKPI on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ProjectKPIs.update", "summary": "ProjectKPIs.update", "tags": ["Project"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateProjectKPIInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ProjectKPI", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProjectKPI"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectKPIs": {"get": {"description": "Returns all defined ProjectKPIs", "operationId": "ProjectKPIs.list", "summary": "ProjectKPIs.list", "tags": ["Project"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ProjectKPIs are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ProjectKPIs", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ProjectKPI"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ProjectKPI", "operationId": "ProjectKPIs.create", "summary": "ProjectKPIs.create", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectKPI on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProjectKPI", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createProjectKPIInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ProjectKPI", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProjectKPI"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectKPIs/batch-delete": {"post": {"description": "Removes ProjectKPIs with given list of ids", "operationId": "ProjectKPIs.batch_delete", "summary": "ProjectKPIs.batch_delete", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectKPIs on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProjectKPIs. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProjectKPI to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ProjectKPI.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectKPIs/batch-modify": {"post": {"description": "Create or update an batch of ProjectKPIs", "operationId": "ProjectKPIs.batch_create_or_update", "summary": "ProjectKPIs.batch_create_or_update", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectKPIs on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProjectKPIs. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProjectKPI", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchProjectKPIInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ProjectKPIs", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectKPIs/batch-restore": {"post": {"description": "Restores ProjectKPIs with given list of ids", "operationId": "ProjectKPIs.batch_restore", "summary": "ProjectKPIs.batch_restore", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectKPIs on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProjectKPIs. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProjectKPI to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ProjectKPI.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectObjectives/{id}": {"get": {"description": "Returns ProjectObjective with given id", "operationId": "ProjectObjectives.get", "summary": "ProjectObjectives.get", "tags": ["Project"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProjectObjective to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ProjectObjective data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProjectObjective"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ProjectObjective with given id", "operationId": "ProjectObjectives.delete", "summary": "ProjectObjectives.delete", "tags": ["Project"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProjectObjective to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectObjective on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ProjectObjective", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ProjectObjective or ProjectObjectives with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ProjectObjective to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectObjective on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ProjectObjectives.update", "summary": "ProjectObjectives.update", "tags": ["Project"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateProjectObjectiveInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ProjectObjective", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProjectObjective"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectObjectives": {"get": {"description": "Returns all defined ProjectObjectives", "operationId": "ProjectObjectives.list", "summary": "ProjectObjectives.list", "tags": ["Project"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ProjectObjectives are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ProjectObjectives", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ProjectObjective"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ProjectObjective", "operationId": "ProjectObjectives.create", "summary": "ProjectObjectives.create", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectObjective on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProjectObjective", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createProjectObjectiveInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ProjectObjective", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProjectObjective"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectObjectives/batch-delete": {"post": {"description": "Removes ProjectObjectives with given list of ids", "operationId": "ProjectObjectives.batch_delete", "summary": "ProjectObjectives.batch_delete", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectObjectives on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProjectObjectives. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProjectObjective to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ProjectObjective.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectObjectives/batch-modify": {"post": {"description": "Create or update an batch of ProjectObjectives", "operationId": "ProjectObjectives.batch_create_or_update", "summary": "ProjectObjectives.batch_create_or_update", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectObjectives on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProjectObjectives. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProjectObjective", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchProjectObjectiveInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ProjectObjectives", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectObjectives/batch-restore": {"post": {"description": "Restores ProjectObjectives with given list of ids", "operationId": "ProjectObjectives.batch_restore", "summary": "ProjectObjectives.batch_restore", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectObjectives on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProjectObjectives. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProjectObjective to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ProjectObjective.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectSharingClientRelations/{id}": {"get": {"description": "Returns ProjectSharingClientRelation with given id", "operationId": "ProjectSharingClientRelations.get", "summary": "ProjectSharingClientRelations.get", "tags": ["Project"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProjectSharingClientRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ProjectSharingClientRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProjectSharingClientRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ProjectSharingClientRelation with given id", "operationId": "ProjectSharingClientRelations.delete", "summary": "ProjectSharingClientRelations.delete", "tags": ["Project"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProjectSharingClientRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectSharingClientRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ProjectSharingClientRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ProjectSharingClientRelation or ProjectSharingClientRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ProjectSharingClientRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectSharingClientRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ProjectSharingClientRelations.update", "summary": "ProjectSharingClientRelations.update", "tags": ["Project"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateProjectSharingClientRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ProjectSharingClientRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProjectSharingClientRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectSharingClientRelations": {"get": {"description": "Returns all defined ProjectSharingClientRelations", "operationId": "ProjectSharingClientRelations.list", "summary": "ProjectSharingClientRelations.list", "tags": ["Project"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ProjectSharingClientRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ProjectSharingClientRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ProjectSharingClientRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ProjectSharingClientRelation", "operationId": "ProjectSharingClientRelations.create", "summary": "ProjectSharingClientRelations.create", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectSharingClientRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProjectSharingClientRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createProjectSharingClientRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ProjectSharingClientRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProjectSharingClientRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectSharingClientRelations/batch-delete": {"post": {"description": "Removes ProjectSharingClientRelations with given list of ids", "operationId": "ProjectSharingClientRelations.batch_delete", "summary": "ProjectSharingClientRelations.batch_delete", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectSharingClientRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProjectSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProjectSharingClientRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ProjectSharingClientRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectSharingClientRelations/batch-modify": {"post": {"description": "Create or update an batch of ProjectSharingClientRelations", "operationId": "ProjectSharingClientRelations.batch_create_or_update", "summary": "ProjectSharingClientRelations.batch_create_or_update", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectSharingClientRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProjectSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProjectSharingClientRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchProjectSharingClientRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ProjectSharingClientRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectSharingClientRelations/batch-restore": {"post": {"description": "Restores ProjectSharingClientRelations with given list of ids", "operationId": "ProjectSharingClientRelations.batch_restore", "summary": "ProjectSharingClientRelations.batch_restore", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectSharingClientRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProjectSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProjectSharingClientRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ProjectSharingClientRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectSharingSalesUnitRelations/{id}": {"get": {"description": "Returns ProjectSharingSalesUnitRelation with given id", "operationId": "ProjectSharingSalesUnitRelations.get", "summary": "ProjectSharingSalesUnitRelations.get", "tags": ["Project"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProjectSharingSalesUnitRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ProjectSharingSalesUnitRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProjectSharingSalesUnitRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ProjectSharingSalesUnitRelation with given id", "operationId": "ProjectSharingSalesUnitRelations.delete", "summary": "ProjectSharingSalesUnitRelations.delete", "tags": ["Project"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProjectSharingSalesUnitRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectSharingSalesUnitRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ProjectSharingSalesUnitRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ProjectSharingSalesUnitRelation or ProjectSharingSalesUnitRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ProjectSharingSalesUnitRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectSharingSalesUnitRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ProjectSharingSalesUnitRelations.update", "summary": "ProjectSharingSalesUnitRelations.update", "tags": ["Project"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateProjectSharingSalesUnitRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ProjectSharingSalesUnitRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProjectSharingSalesUnitRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectSharingSalesUnitRelations": {"get": {"description": "Returns all defined ProjectSharingSalesUnitRelations", "operationId": "ProjectSharingSalesUnitRelations.list", "summary": "ProjectSharingSalesUnitRelations.list", "tags": ["Project"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ProjectSharingSalesUnitRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ProjectSharingSalesUnitRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ProjectSharingSalesUnitRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ProjectSharingSalesUnitRelation", "operationId": "ProjectSharingSalesUnitRelations.create", "summary": "ProjectSharingSalesUnitRelations.create", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectSharingSalesUnitRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProjectSharingSalesUnitRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createProjectSharingSalesUnitRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ProjectSharingSalesUnitRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProjectSharingSalesUnitRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectSharingSalesUnitRelations/batch-delete": {"post": {"description": "Removes ProjectSharingSalesUnitRelations with given list of ids", "operationId": "ProjectSharingSalesUnitRelations.batch_delete", "summary": "ProjectSharingSalesUnitRelations.batch_delete", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectSharingSalesUnitRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProjectSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProjectSharingSalesUnitRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ProjectSharingSalesUnitRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectSharingSalesUnitRelations/batch-modify": {"post": {"description": "Create or update an batch of ProjectSharingSalesUnitRelations", "operationId": "ProjectSharingSalesUnitRelations.batch_create_or_update", "summary": "ProjectSharingSalesUnitRelations.batch_create_or_update", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectSharingSalesUnitRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProjectSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProjectSharingSalesUnitRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchProjectSharingSalesUnitRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ProjectSharingSalesUnitRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectSharingSalesUnitRelations/batch-restore": {"post": {"description": "Restores ProjectSharingSalesUnitRelations with given list of ids", "operationId": "ProjectSharingSalesUnitRelations.batch_restore", "summary": "ProjectSharingSalesUnitRelations.batch_restore", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectSharingSalesUnitRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProjectSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProjectSharingSalesUnitRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ProjectSharingSalesUnitRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectTypes/{id}": {"get": {"description": "Returns ProjectType with given id", "operationId": "ProjectTypes.get", "summary": "ProjectTypes.get", "tags": ["Project"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProjectType to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ProjectType data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProjectType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ProjectType with given id", "operationId": "ProjectTypes.delete", "summary": "ProjectTypes.delete", "tags": ["Project"], "parameters": [{"name": "id", "in": "path", "description": "ID of ProjectType to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectType on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ProjectType", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ProjectType or ProjectTypes with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ProjectType to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectType on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ProjectTypes.update", "summary": "ProjectTypes.update", "tags": ["Project"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateProjectTypeInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ProjectType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProjectType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectTypes": {"get": {"description": "Returns all defined ProjectTypes", "operationId": "ProjectTypes.list", "summary": "ProjectTypes.list", "tags": ["Project"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ProjectTypes are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ProjectTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ProjectType"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ProjectType", "operationId": "ProjectTypes.create", "summary": "ProjectTypes.create", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectType on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProjectType", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createProjectTypeInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ProjectType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ProjectType"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectTypes/batch-delete": {"post": {"description": "Removes ProjectTypes with given list of ids", "operationId": "ProjectTypes.batch_delete", "summary": "ProjectTypes.batch_delete", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectTypes on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProjectTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProjectType to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ProjectType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectTypes/batch-modify": {"post": {"description": "Create or update an batch of ProjectTypes", "operationId": "ProjectTypes.batch_create_or_update", "summary": "ProjectTypes.batch_create_or_update", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectTypes on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProjectTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ProjectType", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchProjectTypeInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ProjectTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ProjectTypes/batch-restore": {"post": {"description": "Restores ProjectTypes with given list of ids", "operationId": "ProjectTypes.batch_restore", "summary": "ProjectTypes.batch_restore", "tags": ["Project"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ProjectTypes on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ProjectTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ProjectType to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ProjectType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Quotes/{id}": {"get": {"description": "Returns Quote with given id", "operationId": "Quotes.get", "summary": "Quotes.get", "tags": ["Quote"], "parameters": [{"name": "id", "in": "path", "description": "ID of Quote to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Quote data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Quote"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Quote with given id", "operationId": "Quotes.delete", "summary": "Quotes.delete", "tags": ["Quote"], "parameters": [{"name": "id", "in": "path", "description": "ID of Quote to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Quote on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Quote", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Quote or Quotes with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Quote to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Quote on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Quotes.update", "summary": "Quotes.update", "tags": ["Quote"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateQuoteInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Quote", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Quote"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Quotes": {"get": {"description": "Returns all defined Quotes", "operationId": "Quotes.list", "summary": "Quotes.list", "tags": ["Quote"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Quotes are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Quotes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Quote"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Quote", "operationId": "Quotes.create", "summary": "Quotes.create", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Quote on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Quote", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createQuoteInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Quote", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Quote"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Quotes/batch-delete": {"post": {"description": "Removes Quotes with given list of ids", "operationId": "Quotes.batch_delete", "summary": "Quotes.batch_delete", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Quotes on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Quotes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Quote to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Quote.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Quotes/batch-modify": {"post": {"description": "Create or update an batch of Quotes", "operationId": "Quotes.batch_create_or_update", "summary": "Quotes.batch_create_or_update", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Quotes on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Quotes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Quote", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchQuoteInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Quotes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Quotes/batch-restore": {"post": {"description": "Restores Quotes with given list of ids", "operationId": "Quotes.batch_restore", "summary": "Quotes.batch_restore", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Quotes on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Quotes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Quote to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Quote.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteAccountRelations/{id}": {"get": {"description": "Returns QuoteAccountRelation with given id", "operationId": "QuoteAccountRelations.get", "summary": "QuoteAccountRelations.get", "tags": ["Quote"], "parameters": [{"name": "id", "in": "path", "description": "ID of QuoteAccountRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "QuoteAccountRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/QuoteAccountRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes QuoteAccountRelation with given id", "operationId": "QuoteAccountRelations.delete", "summary": "QuoteAccountRelations.delete", "tags": ["Quote"], "parameters": [{"name": "id", "in": "path", "description": "ID of QuoteAccountRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteAccountRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted QuoteAccountRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies QuoteAccountRelation or QuoteAccountRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of QuoteAccountRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteAccountRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "QuoteAccountRelations.update", "summary": "QuoteAccountRelations.update", "tags": ["Quote"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateQuoteAccountRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting QuoteAccountRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/QuoteAccountRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteAccountRelations": {"get": {"description": "Returns all defined QuoteAccountRelations", "operationId": "QuoteAccountRelations.list", "summary": "QuoteAccountRelations.list", "tags": ["Quote"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted QuoteAccountRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of QuoteAccountRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/QuoteAccountRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new QuoteAccountRelation", "operationId": "QuoteAccountRelations.create", "summary": "QuoteAccountRelations.create", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteAccountRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new QuoteAccountRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createQuoteAccountRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created QuoteAccountRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/QuoteAccountRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteAccountRelations/batch-delete": {"post": {"description": "Removes QuoteAccountRelations with given list of ids", "operationId": "QuoteAccountRelations.batch_delete", "summary": "QuoteAccountRelations.batch_delete", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteAccountRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for QuoteAccountRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity QuoteAccountRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted QuoteAccountRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteAccountRelations/batch-modify": {"post": {"description": "Create or update an batch of QuoteAccountRelations", "operationId": "QuoteAccountRelations.batch_create_or_update", "summary": "QuoteAccountRelations.batch_create_or_update", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteAccountRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for QuoteAccountRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new QuoteAccountRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchQuoteAccountRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated QuoteAccountRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteAccountRelations/batch-restore": {"post": {"description": "Restores QuoteAccountRelations with given list of ids", "operationId": "QuoteAccountRelations.batch_restore", "summary": "QuoteAccountRelations.batch_restore", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteAccountRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for QuoteAccountRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity QuoteAccountRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored QuoteAccountRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteContactRelations/{id}": {"get": {"description": "Returns QuoteContactRelation with given id", "operationId": "QuoteContactRelations.get", "summary": "QuoteContactRelations.get", "tags": ["Quote"], "parameters": [{"name": "id", "in": "path", "description": "ID of QuoteContactRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "QuoteContactRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/QuoteContactRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes QuoteContactRelation with given id", "operationId": "QuoteContactRelations.delete", "summary": "QuoteContactRelations.delete", "tags": ["Quote"], "parameters": [{"name": "id", "in": "path", "description": "ID of QuoteContactRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteContactRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted QuoteContactRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies QuoteContactRelation or QuoteContactRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of QuoteContactRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteContactRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "QuoteContactRelations.update", "summary": "QuoteContactRelations.update", "tags": ["Quote"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateQuoteContactRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting QuoteContactRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/QuoteContactRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteContactRelations": {"get": {"description": "Returns all defined QuoteContactRelations", "operationId": "QuoteContactRelations.list", "summary": "QuoteContactRelations.list", "tags": ["Quote"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted QuoteContactRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of QuoteContactRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/QuoteContactRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new QuoteContactRelation", "operationId": "QuoteContactRelations.create", "summary": "QuoteContactRelations.create", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteContactRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new QuoteContactRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createQuoteContactRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created QuoteContactRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/QuoteContactRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteContactRelations/batch-delete": {"post": {"description": "Removes QuoteContactRelations with given list of ids", "operationId": "QuoteContactRelations.batch_delete", "summary": "QuoteContactRelations.batch_delete", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteContactRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for QuoteContactRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity QuoteContactRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted QuoteContactRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteContactRelations/batch-modify": {"post": {"description": "Create or update an batch of QuoteContactRelations", "operationId": "QuoteContactRelations.batch_create_or_update", "summary": "QuoteContactRelations.batch_create_or_update", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteContactRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for QuoteContactRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new QuoteContactRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchQuoteContactRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated QuoteContactRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteContactRelations/batch-restore": {"post": {"description": "Restores QuoteContactRelations with given list of ids", "operationId": "QuoteContactRelations.batch_restore", "summary": "QuoteContactRelations.batch_restore", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteContactRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for QuoteContactRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity QuoteContactRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored QuoteContactRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteDataExRelations/{id}": {"get": {"description": "Returns QuoteDataExRelation with given id", "operationId": "QuoteDataExRelations.get", "summary": "QuoteDataExRelations.get", "tags": ["Quote"], "parameters": [{"name": "id", "in": "path", "description": "ID of QuoteDataExRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "QuoteDataExRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/QuoteDataExRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes QuoteDataExRelation with given id", "operationId": "QuoteDataExRelations.delete", "summary": "QuoteDataExRelations.delete", "tags": ["Quote"], "parameters": [{"name": "id", "in": "path", "description": "ID of QuoteDataExRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteDataExRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted QuoteDataExRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies QuoteDataExRelation or QuoteDataExRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of QuoteDataExRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteDataExRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "QuoteDataExRelations.update", "summary": "QuoteDataExRelations.update", "tags": ["Quote"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateQuoteDataExRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting QuoteDataExRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/QuoteDataExRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteDataExRelations": {"get": {"description": "Returns all defined QuoteDataExRelations", "operationId": "QuoteDataExRelations.list", "summary": "QuoteDataExRelations.list", "tags": ["Quote"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted QuoteDataExRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of QuoteDataExRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/QuoteDataExRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new QuoteDataExRelation", "operationId": "QuoteDataExRelations.create", "summary": "QuoteDataExRelations.create", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteDataExRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new QuoteDataExRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createQuoteDataExRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created QuoteDataExRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/QuoteDataExRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteDataExRelations/batch-delete": {"post": {"description": "Removes QuoteDataExRelations with given list of ids", "operationId": "QuoteDataExRelations.batch_delete", "summary": "QuoteDataExRelations.batch_delete", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteDataExRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for QuoteDataExRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity QuoteDataExRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted QuoteDataExRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteDataExRelations/batch-modify": {"post": {"description": "Create or update an batch of QuoteDataExRelations", "operationId": "QuoteDataExRelations.batch_create_or_update", "summary": "QuoteDataExRelations.batch_create_or_update", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteDataExRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for QuoteDataExRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new QuoteDataExRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchQuoteDataExRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated QuoteDataExRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteDataExRelations/batch-restore": {"post": {"description": "Restores QuoteDataExRelations with given list of ids", "operationId": "QuoteDataExRelations.batch_restore", "summary": "QuoteDataExRelations.batch_restore", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteDataExRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for QuoteDataExRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity QuoteDataExRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored QuoteDataExRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteKPIs/{id}": {"get": {"description": "Returns QuoteKPI with given id", "operationId": "QuoteKPIs.get", "summary": "QuoteKPIs.get", "tags": ["Quote"], "parameters": [{"name": "id", "in": "path", "description": "ID of QuoteKPI to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "QuoteKPI data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/QuoteKPI"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes QuoteKPI with given id", "operationId": "QuoteKPIs.delete", "summary": "QuoteKPIs.delete", "tags": ["Quote"], "parameters": [{"name": "id", "in": "path", "description": "ID of QuoteKPI to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteKPI on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted QuoteKPI", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies QuoteKPI or QuoteKPIs with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of QuoteKPI to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteKPI on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "QuoteKPIs.update", "summary": "QuoteKPIs.update", "tags": ["Quote"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateQuoteKPIInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting QuoteKPI", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/QuoteKPI"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteKPIs": {"get": {"description": "Returns all defined QuoteKPIs", "operationId": "QuoteKPIs.list", "summary": "QuoteKPIs.list", "tags": ["Quote"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted QuoteKPIs are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of QuoteKPIs", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/QuoteKPI"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new QuoteKPI", "operationId": "QuoteKPIs.create", "summary": "QuoteKPIs.create", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteKPI on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new QuoteKPI", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createQuoteKPIInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created QuoteKPI", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/QuoteKPI"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteKPIs/batch-delete": {"post": {"description": "Removes QuoteKPIs with given list of ids", "operationId": "QuoteKPIs.batch_delete", "summary": "QuoteKPIs.batch_delete", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteKPIs on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for QuoteKPIs. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity QuoteKPI to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted QuoteKPI.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteKPIs/batch-modify": {"post": {"description": "Create or update an batch of QuoteKPIs", "operationId": "QuoteKPIs.batch_create_or_update", "summary": "QuoteKPIs.batch_create_or_update", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteKPIs on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for QuoteKPIs. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new QuoteKPI", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchQuoteKPIInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated QuoteKPIs", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteKPIs/batch-restore": {"post": {"description": "Restores QuoteKPIs with given list of ids", "operationId": "QuoteKPIs.batch_restore", "summary": "QuoteKPIs.batch_restore", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteKPIs on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for QuoteKPIs. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity QuoteKPI to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored QuoteKPI.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteProcesses/{id}": {"get": {"description": "Returns QuoteProcess with given id", "operationId": "QuoteProcesses.get", "summary": "QuoteProcesses.get", "tags": ["Quote"], "parameters": [{"name": "id", "in": "path", "description": "ID of QuoteProcess to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "QuoteProcess data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/QuoteProcess"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes QuoteProcess with given id", "operationId": "QuoteProcesses.delete", "summary": "QuoteProcesses.delete", "tags": ["Quote"], "parameters": [{"name": "id", "in": "path", "description": "ID of QuoteProcess to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteProcess on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted QuoteProcess", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies QuoteProcess or QuoteProcesses with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of QuoteProcess to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteProcess on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "QuoteProcesses.update", "summary": "QuoteProcesses.update", "tags": ["Quote"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateQuoteProcessInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting QuoteProcess", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/QuoteProcess"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteProcesses": {"get": {"description": "Returns all defined QuoteProcesses", "operationId": "QuoteProcesses.list", "summary": "QuoteProcesses.list", "tags": ["Quote"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted QuoteProcesses are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of QuoteProcesses", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/QuoteProcess"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new QuoteProcess", "operationId": "QuoteProcesses.create", "summary": "QuoteProcesses.create", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteProcess on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new QuoteProcess", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createQuoteProcessInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created QuoteProcess", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/QuoteProcess"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteProcesses/batch-delete": {"post": {"description": "Removes QuoteProcesses with given list of ids", "operationId": "QuoteProcesses.batch_delete", "summary": "QuoteProcesses.batch_delete", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteProcesses on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for QuoteProcesses. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity QuoteProcess to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted QuoteProcess.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteProcesses/batch-modify": {"post": {"description": "Create or update an batch of QuoteProcesses", "operationId": "QuoteProcesses.batch_create_or_update", "summary": "QuoteProcesses.batch_create_or_update", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteProcesses on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for QuoteProcesses. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new QuoteProcess", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchQuoteProcessInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated QuoteProcesses", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteProcesses/batch-restore": {"post": {"description": "Restores QuoteProcesses with given list of ids", "operationId": "QuoteProcesses.batch_restore", "summary": "QuoteProcesses.batch_restore", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteProcesses on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for QuoteProcesses. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity QuoteProcess to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored QuoteProcess.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteSharingClientRelations/{id}": {"get": {"description": "Returns QuoteSharingClientRelation with given id", "operationId": "QuoteSharingClientRelations.get", "summary": "QuoteSharingClientRelations.get", "tags": ["Quote"], "parameters": [{"name": "id", "in": "path", "description": "ID of QuoteSharingClientRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "QuoteSharingClientRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/QuoteSharingClientRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes QuoteSharingClientRelation with given id", "operationId": "QuoteSharingClientRelations.delete", "summary": "QuoteSharingClientRelations.delete", "tags": ["Quote"], "parameters": [{"name": "id", "in": "path", "description": "ID of QuoteSharingClientRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteSharingClientRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted QuoteSharingClientRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies QuoteSharingClientRelation or QuoteSharingClientRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of QuoteSharingClientRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteSharingClientRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "QuoteSharingClientRelations.update", "summary": "QuoteSharingClientRelations.update", "tags": ["Quote"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateQuoteSharingClientRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting QuoteSharingClientRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/QuoteSharingClientRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteSharingClientRelations": {"get": {"description": "Returns all defined QuoteSharingClientRelations", "operationId": "QuoteSharingClientRelations.list", "summary": "QuoteSharingClientRelations.list", "tags": ["Quote"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted QuoteSharingClientRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of QuoteSharingClientRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/QuoteSharingClientRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new QuoteSharingClientRelation", "operationId": "QuoteSharingClientRelations.create", "summary": "QuoteSharingClientRelations.create", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteSharingClientRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new QuoteSharingClientRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createQuoteSharingClientRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created QuoteSharingClientRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/QuoteSharingClientRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteSharingClientRelations/batch-delete": {"post": {"description": "Removes QuoteSharingClientRelations with given list of ids", "operationId": "QuoteSharingClientRelations.batch_delete", "summary": "QuoteSharingClientRelations.batch_delete", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteSharingClientRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for QuoteSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity QuoteSharingClientRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted QuoteSharingClientRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteSharingClientRelations/batch-modify": {"post": {"description": "Create or update an batch of QuoteSharingClientRelations", "operationId": "QuoteSharingClientRelations.batch_create_or_update", "summary": "QuoteSharingClientRelations.batch_create_or_update", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteSharingClientRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for QuoteSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new QuoteSharingClientRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchQuoteSharingClientRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated QuoteSharingClientRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteSharingClientRelations/batch-restore": {"post": {"description": "Restores QuoteSharingClientRelations with given list of ids", "operationId": "QuoteSharingClientRelations.batch_restore", "summary": "QuoteSharingClientRelations.batch_restore", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteSharingClientRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for QuoteSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity QuoteSharingClientRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored QuoteSharingClientRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteSharingSalesUnitRelations/{id}": {"get": {"description": "Returns QuoteSharingSalesUnitRelation with given id", "operationId": "QuoteSharingSalesUnitRelations.get", "summary": "QuoteSharingSalesUnitRelations.get", "tags": ["Quote"], "parameters": [{"name": "id", "in": "path", "description": "ID of QuoteSharingSalesUnitRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "QuoteSharingSalesUnitRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/QuoteSharingSalesUnitRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes QuoteSharingSalesUnitRelation with given id", "operationId": "QuoteSharingSalesUnitRelations.delete", "summary": "QuoteSharingSalesUnitRelations.delete", "tags": ["Quote"], "parameters": [{"name": "id", "in": "path", "description": "ID of QuoteSharingSalesUnitRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteSharingSalesUnitRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted QuoteSharingSalesUnitRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies QuoteSharingSalesUnitRelation or QuoteSharingSalesUnitRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of QuoteSharingSalesUnitRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteSharingSalesUnitRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "QuoteSharingSalesUnitRelations.update", "summary": "QuoteSharingSalesUnitRelations.update", "tags": ["Quote"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateQuoteSharingSalesUnitRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting QuoteSharingSalesUnitRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/QuoteSharingSalesUnitRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteSharingSalesUnitRelations": {"get": {"description": "Returns all defined QuoteSharingSalesUnitRelations", "operationId": "QuoteSharingSalesUnitRelations.list", "summary": "QuoteSharingSalesUnitRelations.list", "tags": ["Quote"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted QuoteSharingSalesUnitRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of QuoteSharingSalesUnitRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/QuoteSharingSalesUnitRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new QuoteSharingSalesUnitRelation", "operationId": "QuoteSharingSalesUnitRelations.create", "summary": "QuoteSharingSalesUnitRelations.create", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteSharingSalesUnitRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new QuoteSharingSalesUnitRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createQuoteSharingSalesUnitRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created QuoteSharingSalesUnitRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/QuoteSharingSalesUnitRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteSharingSalesUnitRelations/batch-delete": {"post": {"description": "Removes QuoteSharingSalesUnitRelations with given list of ids", "operationId": "QuoteSharingSalesUnitRelations.batch_delete", "summary": "QuoteSharingSalesUnitRelations.batch_delete", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteSharingSalesUnitRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for QuoteSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity QuoteSharingSalesUnitRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted QuoteSharingSalesUnitRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteSharingSalesUnitRelations/batch-modify": {"post": {"description": "Create or update an batch of QuoteSharingSalesUnitRelations", "operationId": "QuoteSharingSalesUnitRelations.batch_create_or_update", "summary": "QuoteSharingSalesUnitRelations.batch_create_or_update", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteSharingSalesUnitRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for QuoteSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new QuoteSharingSalesUnitRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchQuoteSharingSalesUnitRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated QuoteSharingSalesUnitRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteSharingSalesUnitRelations/batch-restore": {"post": {"description": "Restores QuoteSharingSalesUnitRelations with given list of ids", "operationId": "QuoteSharingSalesUnitRelations.batch_restore", "summary": "QuoteSharingSalesUnitRelations.batch_restore", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteSharingSalesUnitRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for QuoteSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity QuoteSharingSalesUnitRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored QuoteSharingSalesUnitRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteTypes/{id}": {"get": {"description": "Returns QuoteType with given id", "operationId": "QuoteTypes.get", "summary": "QuoteTypes.get", "tags": ["Quote"], "parameters": [{"name": "id", "in": "path", "description": "ID of QuoteType to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "QuoteType data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/QuoteType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes QuoteType with given id", "operationId": "QuoteTypes.delete", "summary": "QuoteTypes.delete", "tags": ["Quote"], "parameters": [{"name": "id", "in": "path", "description": "ID of QuoteType to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteType on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted QuoteType", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies QuoteType or QuoteTypes with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of QuoteType to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteType on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "QuoteTypes.update", "summary": "QuoteTypes.update", "tags": ["Quote"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateQuoteTypeInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting QuoteType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/QuoteType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteTypes": {"get": {"description": "Returns all defined QuoteTypes", "operationId": "QuoteTypes.list", "summary": "QuoteTypes.list", "tags": ["Quote"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted QuoteTypes are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of QuoteTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/QuoteType"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new QuoteType", "operationId": "QuoteTypes.create", "summary": "QuoteTypes.create", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteType on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new QuoteType", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createQuoteTypeInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created QuoteType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/QuoteType"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteTypes/batch-delete": {"post": {"description": "Removes QuoteTypes with given list of ids", "operationId": "QuoteTypes.batch_delete", "summary": "QuoteTypes.batch_delete", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteTypes on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for QuoteTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity QuoteType to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted QuoteType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteTypes/batch-modify": {"post": {"description": "Create or update an batch of QuoteTypes", "operationId": "QuoteTypes.batch_create_or_update", "summary": "QuoteTypes.batch_create_or_update", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteTypes on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for QuoteTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new QuoteType", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchQuoteTypeInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated QuoteTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/QuoteTypes/batch-restore": {"post": {"description": "Restores QuoteTypes with given list of ids", "operationId": "QuoteTypes.batch_restore", "summary": "QuoteTypes.batch_restore", "tags": ["Quote"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of QuoteTypes on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for QuoteTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity QuoteType to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored QuoteType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Reports/{id}": {"get": {"description": "Returns Report with given id", "operationId": "Reports.get", "summary": "Reports.get", "tags": ["Report"], "parameters": [{"name": "id", "in": "path", "description": "ID of Report to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Report data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Report"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Reports": {"get": {"description": "Returns all defined Reports", "operationId": "Reports.list", "summary": "Reports.list", "tags": ["Report"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Reports are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Reports", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Report"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ReportFolders/{id}": {"get": {"description": "Returns ReportFolder with given id", "operationId": "ReportFolders.get", "summary": "ReportFolders.get", "tags": ["Report"], "parameters": [{"name": "id", "in": "path", "description": "ID of ReportFolder to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ReportFolder data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ReportFolder"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ReportFolders": {"get": {"description": "Returns all defined ReportFolders", "operationId": "ReportFolders.list", "summary": "ReportFolders.list", "tags": ["Report"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ReportFolders are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ReportFolders", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ReportFolder"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ReportSchedules/{id}": {"get": {"description": "Returns ReportSchedule with given id", "operationId": "ReportSchedules.get", "summary": "ReportSchedules.get", "tags": ["Report"], "parameters": [{"name": "id", "in": "path", "description": "ID of ReportSchedule to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ReportSchedule data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ReportSchedule"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes ReportSchedule with given id", "operationId": "ReportSchedules.delete", "summary": "ReportSchedules.delete", "tags": ["Report"], "parameters": [{"name": "id", "in": "path", "description": "ID of ReportSchedule to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ReportSchedule on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted ReportSchedule", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies ReportSchedule or ReportSchedules with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of ReportSchedule to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of ReportSchedule on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "ReportSchedules.update", "summary": "ReportSchedules.update", "tags": ["Report"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateReportScheduleInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting ReportSchedule", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ReportSchedule"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ReportSchedules": {"get": {"description": "Returns all defined ReportSchedules", "operationId": "ReportSchedules.list", "summary": "ReportSchedules.list", "tags": ["Report"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ReportSchedules are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ReportSchedules", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ReportSchedule"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new ReportSchedule", "operationId": "ReportSchedules.create", "summary": "ReportSchedules.create", "tags": ["Report"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ReportSchedule on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ReportSchedule", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createReportScheduleInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created ReportSchedule", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ReportSchedule"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ReportSchedules/batch-delete": {"post": {"description": "Removes ReportSchedules with given list of ids", "operationId": "ReportSchedules.batch_delete", "summary": "ReportSchedules.batch_delete", "tags": ["Report"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ReportSchedules on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ReportSchedules. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ReportSchedule to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted ReportSchedule.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ReportSchedules/batch-modify": {"post": {"description": "Create or update an batch of ReportSchedules", "operationId": "ReportSchedules.batch_create_or_update", "summary": "ReportSchedules.batch_create_or_update", "tags": ["Report"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ReportSchedules on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ReportSchedules. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new ReportSchedule", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchReportScheduleInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated ReportSchedules", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ReportSchedules/batch-restore": {"post": {"description": "Restores ReportSchedules with given list of ids", "operationId": "ReportSchedules.batch_restore", "summary": "ReportSchedules.batch_restore", "tags": ["Report"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of ReportSchedules on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for ReportSchedules. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity ReportSchedule to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored ReportSchedule.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ReportSharingClientRelations/{id}": {"get": {"description": "Returns ReportSharingClientRelation with given id", "operationId": "ReportSharingClientRelations.get", "summary": "ReportSharingClientRelations.get", "tags": ["Report"], "parameters": [{"name": "id", "in": "path", "description": "ID of ReportSharingClientRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ReportSharingClientRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ReportSharingClientRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ReportSharingClientRelations": {"get": {"description": "Returns all defined ReportSharingClientRelations", "operationId": "ReportSharingClientRelations.list", "summary": "ReportSharingClientRelations.list", "tags": ["Report"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ReportSharingClientRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ReportSharingClientRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ReportSharingClientRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ReportSharingSalesUnitRelations/{id}": {"get": {"description": "Returns ReportSharingSalesUnitRelation with given id", "operationId": "ReportSharingSalesUnitRelations.get", "summary": "ReportSharingSalesUnitRelations.get", "tags": ["Report"], "parameters": [{"name": "id", "in": "path", "description": "ID of ReportSharingSalesUnitRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "ReportSharingSalesUnitRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/ReportSharingSalesUnitRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/ReportSharingSalesUnitRelations": {"get": {"description": "Returns all defined ReportSharingSalesUnitRelations", "operationId": "ReportSharingSalesUnitRelations.list", "summary": "ReportSharingSalesUnitRelations.list", "tags": ["Report"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted ReportSharingSalesUnitRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of ReportSharingSalesUnitRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/ReportSharingSalesUnitRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/SalesRoles/{id}": {"get": {"description": "Returns SalesRole with given id", "operationId": "SalesRoles.get", "summary": "SalesRoles.get", "tags": ["SalesRole"], "parameters": [{"name": "id", "in": "path", "description": "ID of SalesRole to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "SalesRole data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/SalesRole"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes SalesRole with given id", "operationId": "SalesRoles.delete", "summary": "SalesRoles.delete", "tags": ["SalesRole"], "parameters": [{"name": "id", "in": "path", "description": "ID of SalesRole to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of SalesRole on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted SalesRole", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies SalesRole or SalesRoles with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of SalesRole to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of SalesRole on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "SalesRoles.update", "summary": "SalesRoles.update", "tags": ["SalesRole"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateSalesRoleInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting SalesRole", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/SalesRole"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/SalesRoles": {"get": {"description": "Returns all defined SalesRoles", "operationId": "SalesRoles.list", "summary": "SalesRoles.list", "tags": ["SalesRole"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted SalesRoles are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of SalesRoles", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/SalesRole"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new SalesRole", "operationId": "SalesRoles.create", "summary": "SalesRoles.create", "tags": ["SalesRole"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of SalesRole on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new SalesRole", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createSalesRoleInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created SalesRole", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/SalesRole"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/SalesRoles/batch-delete": {"post": {"description": "Removes SalesRoles with given list of ids", "operationId": "SalesRoles.batch_delete", "summary": "SalesRoles.batch_delete", "tags": ["SalesRole"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of SalesRoles on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for SalesRoles. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity SalesRole to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted SalesRole.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/SalesRoles/batch-modify": {"post": {"description": "Create or update an batch of SalesRoles", "operationId": "SalesRoles.batch_create_or_update", "summary": "SalesRoles.batch_create_or_update", "tags": ["SalesRole"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of SalesRoles on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for SalesRoles. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new SalesRole", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchSalesRoleInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated SalesRoles", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/SalesRoles/batch-restore": {"post": {"description": "Restores SalesRoles with given list of ids", "operationId": "SalesRoles.batch_restore", "summary": "SalesRoles.batch_restore", "tags": ["SalesRole"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of SalesRoles on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for SalesRoles. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity SalesRole to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored SalesRole.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/SalesUnits/{id}": {"get": {"description": "Returns SalesUnit with given id", "operationId": "SalesUnits.get", "summary": "SalesUnits.get", "tags": ["SalesUnit"], "parameters": [{"name": "id", "in": "path", "description": "ID of SalesUnit to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "SalesUnit data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/SalesUnit"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes SalesUnit with given id", "operationId": "SalesUnits.delete", "summary": "SalesUnits.delete", "tags": ["SalesUnit"], "parameters": [{"name": "id", "in": "path", "description": "ID of SalesUnit to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of SalesUnit on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted SalesUnit", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies SalesUnit or SalesUnits with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of SalesUnit to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of SalesUnit on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "SalesUnits.update", "summary": "SalesUnits.update", "tags": ["SalesUnit"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateSalesUnitInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting SalesUnit", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/SalesUnit"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/SalesUnits": {"get": {"description": "Returns all defined SalesUnits", "operationId": "SalesUnits.list", "summary": "SalesUnits.list", "tags": ["SalesUnit"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted SalesUnits are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of SalesUnits", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/SalesUnit"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new SalesUnit", "operationId": "SalesUnits.create", "summary": "SalesUnits.create", "tags": ["SalesUnit"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of SalesUnit on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new SalesUnit", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createSalesUnitInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created SalesUnit", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/SalesUnit"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/SalesUnits/batch-delete": {"post": {"description": "Removes SalesUnits with given list of ids", "operationId": "SalesUnits.batch_delete", "summary": "SalesUnits.batch_delete", "tags": ["SalesUnit"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of SalesUnits on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for SalesUnits. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity SalesUnit to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted SalesUnit.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/SalesUnits/batch-modify": {"post": {"description": "Create or update an batch of SalesUnits", "operationId": "SalesUnits.batch_create_or_update", "summary": "SalesUnits.batch_create_or_update", "tags": ["SalesUnit"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of SalesUnits on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for SalesUnits. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new SalesUnit", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchSalesUnitInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated SalesUnits", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/SalesUnits/batch-restore": {"post": {"description": "Restores SalesUnits with given list of ids", "operationId": "SalesUnits.batch_restore", "summary": "SalesUnits.batch_restore", "tags": ["SalesUnit"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of SalesUnits on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for SalesUnits. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity SalesUnit to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored SalesUnit.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/SalesUnitClientRelations/{id}": {"get": {"description": "Returns SalesUnitClientRelation with given id", "operationId": "SalesUnitClientRelations.get", "summary": "SalesUnitClientRelations.get", "tags": ["SalesUnit"], "parameters": [{"name": "id", "in": "path", "description": "ID of SalesUnitClientRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "SalesUnitClientRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/SalesUnitClientRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/SalesUnitClientRelations": {"get": {"description": "Returns all defined SalesUnitClientRelations", "operationId": "SalesUnitClientRelations.list", "summary": "SalesUnitClientRelations.list", "tags": ["SalesUnit"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted SalesUnitClientRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of SalesUnitClientRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/SalesUnitClientRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Steps/{id}": {"get": {"description": "Returns Step with given id", "operationId": "Steps.get", "summary": "Steps.get", "tags": ["Step"], "parameters": [{"name": "id", "in": "path", "description": "ID of Step to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Step data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Step"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Step with given id", "operationId": "Steps.delete", "summary": "Steps.delete", "tags": ["Step"], "parameters": [{"name": "id", "in": "path", "description": "ID of Step to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Step on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Step", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Step or Steps with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Step to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Step on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Steps.update", "summary": "Steps.update", "tags": ["Step"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateStepInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Step", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Step"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Steps": {"get": {"description": "Returns all defined Steps", "operationId": "Steps.list", "summary": "Steps.list", "tags": ["Step"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Steps are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Steps", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Step"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Step", "operationId": "Steps.create", "summary": "Steps.create", "tags": ["Step"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Step on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Step", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createStepInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Step", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Step"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Steps/batch-delete": {"post": {"description": "Removes Steps with given list of ids", "operationId": "Steps.batch_delete", "summary": "Steps.batch_delete", "tags": ["Step"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Steps on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Steps. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Step to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Step.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Steps/batch-modify": {"post": {"description": "Create or update an batch of Steps", "operationId": "Steps.batch_create_or_update", "summary": "Steps.batch_create_or_update", "tags": ["Step"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Steps on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Steps. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Step", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchStepInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Steps", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Steps/batch-restore": {"post": {"description": "Restores Steps with given list of ids", "operationId": "Steps.batch_restore", "summary": "Steps.batch_restore", "tags": ["Step"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Steps on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Steps. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Step to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Step.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/StepChecklists/{id}": {"get": {"description": "Returns StepChecklist with given id", "operationId": "StepChecklists.get", "summary": "StepChecklists.get", "tags": ["Step"], "parameters": [{"name": "id", "in": "path", "description": "ID of StepChecklist to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "StepChecklist data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/StepChecklist"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes StepChecklist with given id", "operationId": "StepChecklists.delete", "summary": "StepChecklists.delete", "tags": ["Step"], "parameters": [{"name": "id", "in": "path", "description": "ID of StepChecklist to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of StepChecklist on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted StepChecklist", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies StepChecklist or StepChecklists with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of StepChecklist to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of StepChecklist on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "StepChecklists.update", "summary": "StepChecklists.update", "tags": ["Step"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateStepChecklistInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting StepChecklist", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/StepChecklist"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/StepChecklists": {"get": {"description": "Returns all defined StepChecklists", "operationId": "StepChecklists.list", "summary": "StepChecklists.list", "tags": ["Step"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted StepChecklists are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of StepChecklists", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/StepChecklist"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new StepChecklist", "operationId": "StepChecklists.create", "summary": "StepChecklists.create", "tags": ["Step"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of StepChecklist on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new StepChecklist", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createStepChecklistInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created StepChecklist", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/StepChecklist"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/StepChecklists/batch-delete": {"post": {"description": "Removes StepChecklists with given list of ids", "operationId": "StepChecklists.batch_delete", "summary": "StepChecklists.batch_delete", "tags": ["Step"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of StepChecklists on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for StepChecklists. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity StepChecklist to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted StepChecklist.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/StepChecklists/batch-modify": {"post": {"description": "Create or update an batch of StepChecklists", "operationId": "StepChecklists.batch_create_or_update", "summary": "StepChecklists.batch_create_or_update", "tags": ["Step"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of StepChecklists on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for StepChecklists. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new StepChecklist", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchStepChecklistInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated StepChecklists", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/StepChecklists/batch-restore": {"post": {"description": "Restores StepChecklists with given list of ids", "operationId": "StepChecklists.batch_restore", "summary": "StepChecklists.batch_restore", "tags": ["Step"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of StepChecklists on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for StepChecklists. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity StepChecklist to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored StepChecklist.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/StepChecklistSalesRoleRelations/{id}": {"get": {"description": "Returns StepChecklistSalesRoleRelation with given id", "operationId": "StepChecklistSalesRoleRelations.get", "summary": "StepChecklistSalesRoleRelations.get", "tags": ["Step"], "parameters": [{"name": "id", "in": "path", "description": "ID of StepChecklistSalesRoleRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "StepChecklistSalesRoleRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/StepChecklistSalesRoleRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes StepChecklistSalesRoleRelation with given id", "operationId": "StepChecklistSalesRoleRelations.delete", "summary": "StepChecklistSalesRoleRelations.delete", "tags": ["Step"], "parameters": [{"name": "id", "in": "path", "description": "ID of StepChecklistSalesRoleRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of StepChecklistSalesRoleRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted StepChecklistSalesRoleRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies StepChecklistSalesRoleRelation or StepChecklistSalesRoleRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of StepChecklistSalesRoleRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of StepChecklistSalesRoleRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "StepChecklistSalesRoleRelations.update", "summary": "StepChecklistSalesRoleRelations.update", "tags": ["Step"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateStepChecklistSalesRoleRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting StepChecklistSalesRoleRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/StepChecklistSalesRoleRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/StepChecklistSalesRoleRelations": {"get": {"description": "Returns all defined StepChecklistSalesRoleRelations", "operationId": "StepChecklistSalesRoleRelations.list", "summary": "StepChecklistSalesRoleRelations.list", "tags": ["Step"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted StepChecklistSalesRoleRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of StepChecklistSalesRoleRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/StepChecklistSalesRoleRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new StepChecklistSalesRoleRelation", "operationId": "StepChecklistSalesRoleRelations.create", "summary": "StepChecklistSalesRoleRelations.create", "tags": ["Step"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of StepChecklistSalesRoleRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new StepChecklistSalesRoleRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createStepChecklistSalesRoleRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created StepChecklistSalesRoleRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/StepChecklistSalesRoleRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/StepChecklistSalesRoleRelations/batch-delete": {"post": {"description": "Removes StepChecklistSalesRoleRelations with given list of ids", "operationId": "StepChecklistSalesRoleRelations.batch_delete", "summary": "StepChecklistSalesRoleRelations.batch_delete", "tags": ["Step"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of StepChecklistSalesRoleRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for StepChecklistSalesRoleRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity StepChecklistSalesRoleRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted StepChecklistSalesRoleRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/StepChecklistSalesRoleRelations/batch-modify": {"post": {"description": "Create or update an batch of StepChecklistSalesRoleRelations", "operationId": "StepChecklistSalesRoleRelations.batch_create_or_update", "summary": "StepChecklistSalesRoleRelations.batch_create_or_update", "tags": ["Step"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of StepChecklistSalesRoleRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for StepChecklistSalesRoleRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new StepChecklistSalesRoleRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchStepChecklistSalesRoleRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated StepChecklistSalesRoleRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/StepChecklistSalesRoleRelations/batch-restore": {"post": {"description": "Restores StepChecklistSalesRoleRelations with given list of ids", "operationId": "StepChecklistSalesRoleRelations.batch_restore", "summary": "StepChecklistSalesRoleRelations.batch_restore", "tags": ["Step"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of StepChecklistSalesRoleRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for StepChecklistSalesRoleRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity StepChecklistSalesRoleRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored StepChecklistSalesRoleRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Tags/{id}": {"get": {"description": "Returns Tag with given id", "operationId": "Tags.get", "summary": "Tags.get", "tags": ["Tag"], "parameters": [{"name": "id", "in": "path", "description": "ID of Tag to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Tag data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Tag"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Tag with given id", "operationId": "Tags.delete", "summary": "Tags.delete", "tags": ["Tag"], "parameters": [{"name": "id", "in": "path", "description": "ID of Tag to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Tag on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Tag", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Tag or Tags with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Tag to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Tag on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Tags.update", "summary": "Tags.update", "tags": ["Tag"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateTagInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Tag", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Tag"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Tags": {"get": {"description": "Returns all defined Tags", "operationId": "Tags.list", "summary": "Tags.list", "tags": ["Tag"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Tags are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Tags", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Tag"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Tag", "operationId": "Tags.create", "summary": "Tags.create", "tags": ["Tag"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Tag on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Tag", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createTagInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Tag", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Tag"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Tags/batch-delete": {"post": {"description": "Removes Tags with given list of ids", "operationId": "Tags.batch_delete", "summary": "Tags.batch_delete", "tags": ["Tag"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Tags on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Tags. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Tag to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Tag.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Tags/batch-modify": {"post": {"description": "Create or update an batch of Tags", "operationId": "Tags.batch_create_or_update", "summary": "Tags.batch_create_or_update", "tags": ["Tag"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Tags on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Tags. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Tag", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchTagInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Tags", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Tags/batch-restore": {"post": {"description": "Restores Tags with given list of ids", "operationId": "Tags.batch_restore", "summary": "Tags.batch_restore", "tags": ["Tag"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Tags on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Tags. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Tag to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Tag.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TagRelations/{id}": {"get": {"description": "Returns TagRelation with given id", "operationId": "TagRelations.get", "summary": "TagRelations.get", "tags": ["Tag"], "parameters": [{"name": "id", "in": "path", "description": "ID of TagRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "TagRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TagRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes TagRelation with given id", "operationId": "TagRelations.delete", "summary": "TagRelations.delete", "tags": ["Tag"], "parameters": [{"name": "id", "in": "path", "description": "ID of TagRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of TagRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted TagRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies TagRelation or TagRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of TagRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of TagRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "TagRelations.update", "summary": "TagRelations.update", "tags": ["Tag"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateTagRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting TagRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TagRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TagRelations": {"get": {"description": "Returns all defined TagRelations", "operationId": "TagRelations.list", "summary": "TagRelations.list", "tags": ["Tag"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted TagRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of TagRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/TagRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new TagRelation", "operationId": "TagRelations.create", "summary": "TagRelations.create", "tags": ["Tag"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TagRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new TagRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createTagRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created TagRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TagRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TagRelations/batch-delete": {"post": {"description": "Removes TagRelations with given list of ids", "operationId": "TagRelations.batch_delete", "summary": "TagRelations.batch_delete", "tags": ["Tag"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TagRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TagRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity TagRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted TagRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TagRelations/batch-modify": {"post": {"description": "Create or update an batch of TagRelations", "operationId": "TagRelations.batch_create_or_update", "summary": "TagRelations.batch_create_or_update", "tags": ["Tag"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TagRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TagRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new TagRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchTagRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated TagRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TagRelations/batch-restore": {"post": {"description": "Restores TagRelations with given list of ids", "operationId": "TagRelations.batch_restore", "summary": "TagRelations.batch_restore", "tags": ["Tag"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TagRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TagRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity TagRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored TagRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Targets/{id}": {"get": {"description": "Returns Target with given id", "operationId": "Targets.get", "summary": "Targets.get", "tags": ["Target"], "parameters": [{"name": "id", "in": "path", "description": "ID of Target to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Target data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Target"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Target with given id", "operationId": "Targets.delete", "summary": "Targets.delete", "tags": ["Target"], "parameters": [{"name": "id", "in": "path", "description": "ID of Target to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Target on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Target", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Target or Targets with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Target to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Target on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Targets.update", "summary": "Targets.update", "tags": ["Target"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateTargetInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Target", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Target"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Targets": {"get": {"description": "Returns all defined Targets", "operationId": "Targets.list", "summary": "Targets.list", "tags": ["Target"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Targets are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Targets", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Target"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Target", "operationId": "Targets.create", "summary": "Targets.create", "tags": ["Target"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Target on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Target", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createTargetInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Target", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Target"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Targets/batch-delete": {"post": {"description": "Removes Targets with given list of ids", "operationId": "Targets.batch_delete", "summary": "Targets.batch_delete", "tags": ["Target"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Targets on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Targets. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Target to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Target.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Targets/batch-modify": {"post": {"description": "Create or update an batch of Targets", "operationId": "Targets.batch_create_or_update", "summary": "Targets.batch_create_or_update", "tags": ["Target"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Targets on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Targets. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Target", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchTargetInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Targets", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Targets/batch-restore": {"post": {"description": "Restores Targets with given list of ids", "operationId": "Targets.batch_restore", "summary": "Targets.batch_restore", "tags": ["Target"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Targets on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Targets. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Target to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Target.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TargetRelations/{id}": {"get": {"description": "Returns TargetRelation with given id", "operationId": "TargetRelations.get", "summary": "TargetRelations.get", "tags": ["Target"], "parameters": [{"name": "id", "in": "path", "description": "ID of TargetRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "TargetRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TargetRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes TargetRelation with given id", "operationId": "TargetRelations.delete", "summary": "TargetRelations.delete", "tags": ["Target"], "parameters": [{"name": "id", "in": "path", "description": "ID of TargetRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of TargetRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted TargetRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies TargetRelation or TargetRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of TargetRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of TargetRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "TargetRelations.update", "summary": "TargetRelations.update", "tags": ["Target"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateTargetRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting TargetRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TargetRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TargetRelations": {"get": {"description": "Returns all defined TargetRelations", "operationId": "TargetRelations.list", "summary": "TargetRelations.list", "tags": ["Target"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted TargetRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of TargetRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/TargetRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new TargetRelation", "operationId": "TargetRelations.create", "summary": "TargetRelations.create", "tags": ["Target"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TargetRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new TargetRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createTargetRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created TargetRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TargetRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TargetRelations/batch-delete": {"post": {"description": "Removes TargetRelations with given list of ids", "operationId": "TargetRelations.batch_delete", "summary": "TargetRelations.batch_delete", "tags": ["Target"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TargetRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TargetRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity TargetRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted TargetRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TargetRelations/batch-modify": {"post": {"description": "Create or update an batch of TargetRelations", "operationId": "TargetRelations.batch_create_or_update", "summary": "TargetRelations.batch_create_or_update", "tags": ["Target"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TargetRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TargetRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new TargetRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchTargetRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated TargetRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TargetRelations/batch-restore": {"post": {"description": "Restores TargetRelations with given list of ids", "operationId": "TargetRelations.batch_restore", "summary": "TargetRelations.batch_restore", "tags": ["Target"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TargetRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TargetRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity TargetRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored TargetRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Tasks/{id}": {"get": {"description": "Returns Task with given id", "operationId": "Tasks.get", "summary": "Tasks.get", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of Task to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Task data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Task"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Task with given id", "operationId": "Tasks.delete", "summary": "Tasks.delete", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of Task to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Task on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Task", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Task or Tasks with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Task to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Task on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Tasks.update", "summary": "Tasks.update", "tags": ["Activity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateTaskInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Task", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Task"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Tasks": {"get": {"description": "Returns all defined Tasks", "operationId": "Tasks.list", "summary": "Tasks.list", "tags": ["Activity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Tasks are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Tasks", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Task"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Task", "operationId": "Tasks.create", "summary": "Tasks.create", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Task on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Task", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createTaskInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Task", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Task"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Tasks/batch-delete": {"post": {"description": "Removes Tasks with given list of ids", "operationId": "Tasks.batch_delete", "summary": "Tasks.batch_delete", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Tasks on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Tasks. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Task to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Task.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Tasks/batch-modify": {"post": {"description": "Create or update an batch of Tasks", "operationId": "Tasks.batch_create_or_update", "summary": "Tasks.batch_create_or_update", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Tasks on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Tasks. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Task", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchTaskInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Tasks", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Tasks/batch-restore": {"post": {"description": "Restores Tasks with given list of ids", "operationId": "Tasks.batch_restore", "summary": "Tasks.batch_restore", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Tasks on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Tasks. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Task to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Task.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TaskRecurrences/{id}": {"get": {"description": "Returns TaskRecurrence with given id", "operationId": "TaskRecurrences.get", "summary": "TaskRecurrences.get", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of TaskRecurrence to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "TaskRecurrence data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TaskRecurrence"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes TaskRecurrence with given id", "operationId": "TaskRecurrences.delete", "summary": "TaskRecurrences.delete", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of TaskRecurrence to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of TaskRecurrence on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted TaskRecurrence", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies TaskRecurrence or TaskRecurrences with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of TaskRecurrence to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of TaskRecurrence on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "TaskRecurrences.update", "summary": "TaskRecurrences.update", "tags": ["Activity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateTaskRecurrenceInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting TaskRecurrence", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TaskRecurrence"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TaskRecurrences": {"get": {"description": "Returns all defined TaskRecurrences", "operationId": "TaskRecurrences.list", "summary": "TaskRecurrences.list", "tags": ["Activity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted TaskRecurrences are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of TaskRecurrences", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/TaskRecurrence"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new TaskRecurrence", "operationId": "TaskRecurrences.create", "summary": "TaskRecurrences.create", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TaskRecurrence on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new TaskRecurrence", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createTaskRecurrenceInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created TaskRecurrence", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TaskRecurrence"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TaskRecurrences/batch-delete": {"post": {"description": "Removes TaskRecurrences with given list of ids", "operationId": "TaskRecurrences.batch_delete", "summary": "TaskRecurrences.batch_delete", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TaskRecurrences on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TaskRecurrences. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity TaskRecurrence to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted TaskRecurrence.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TaskRecurrences/batch-modify": {"post": {"description": "Create or update an batch of TaskRecurrences", "operationId": "TaskRecurrences.batch_create_or_update", "summary": "TaskRecurrences.batch_create_or_update", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TaskRecurrences on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TaskRecurrences. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new TaskRecurrence", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchTaskRecurrenceInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated TaskRecurrences", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TaskRecurrences/batch-restore": {"post": {"description": "Restores TaskRecurrences with given list of ids", "operationId": "TaskRecurrences.batch_restore", "summary": "TaskRecurrences.batch_restore", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TaskRecurrences on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TaskRecurrences. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity TaskRecurrence to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored TaskRecurrence.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TaskReminders/{id}": {"get": {"description": "Returns TaskReminder with given id", "operationId": "TaskReminders.get", "summary": "TaskReminders.get", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of TaskReminder to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "TaskReminder data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TaskReminder"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes TaskReminder with given id", "operationId": "TaskReminders.delete", "summary": "TaskReminders.delete", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of TaskReminder to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of TaskReminder on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted TaskReminder", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies TaskReminder or TaskReminders with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of TaskReminder to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of TaskReminder on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "TaskReminders.update", "summary": "TaskReminders.update", "tags": ["Activity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateTaskReminderInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting TaskReminder", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TaskReminder"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TaskReminders": {"get": {"description": "Returns all defined TaskReminders", "operationId": "TaskReminders.list", "summary": "TaskReminders.list", "tags": ["Activity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted TaskReminders are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of TaskReminders", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/TaskReminder"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new TaskReminder", "operationId": "TaskReminders.create", "summary": "TaskReminders.create", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TaskReminder on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new TaskReminder", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createTaskReminderInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created TaskReminder", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TaskReminder"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TaskReminders/batch-delete": {"post": {"description": "Removes TaskReminders with given list of ids", "operationId": "TaskReminders.batch_delete", "summary": "TaskReminders.batch_delete", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TaskReminders on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TaskReminders. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity TaskReminder to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted TaskReminder.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TaskReminders/batch-modify": {"post": {"description": "Create or update an batch of TaskReminders", "operationId": "TaskReminders.batch_create_or_update", "summary": "TaskReminders.batch_create_or_update", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TaskReminders on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TaskReminders. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new TaskReminder", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchTaskReminderInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated TaskReminders", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TaskReminders/batch-restore": {"post": {"description": "Restores TaskReminders with given list of ids", "operationId": "TaskReminders.batch_restore", "summary": "TaskReminders.batch_restore", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TaskReminders on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TaskReminders. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity TaskReminder to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored TaskReminder.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TaskSharingClientRelations/{id}": {"get": {"description": "Returns TaskSharingClientRelation with given id", "operationId": "TaskSharingClientRelations.get", "summary": "TaskSharingClientRelations.get", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of TaskSharingClientRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "TaskSharingClientRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TaskSharingClientRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes TaskSharingClientRelation with given id", "operationId": "TaskSharingClientRelations.delete", "summary": "TaskSharingClientRelations.delete", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of TaskSharingClientRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of TaskSharingClientRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted TaskSharingClientRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies TaskSharingClientRelation or TaskSharingClientRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of TaskSharingClientRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of TaskSharingClientRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "TaskSharingClientRelations.update", "summary": "TaskSharingClientRelations.update", "tags": ["Activity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateTaskSharingClientRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting TaskSharingClientRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TaskSharingClientRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TaskSharingClientRelations": {"get": {"description": "Returns all defined TaskSharingClientRelations", "operationId": "TaskSharingClientRelations.list", "summary": "TaskSharingClientRelations.list", "tags": ["Activity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted TaskSharingClientRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of TaskSharingClientRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/TaskSharingClientRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new TaskSharingClientRelation", "operationId": "TaskSharingClientRelations.create", "summary": "TaskSharingClientRelations.create", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TaskSharingClientRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new TaskSharingClientRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createTaskSharingClientRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created TaskSharingClientRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TaskSharingClientRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TaskSharingClientRelations/batch-delete": {"post": {"description": "Removes TaskSharingClientRelations with given list of ids", "operationId": "TaskSharingClientRelations.batch_delete", "summary": "TaskSharingClientRelations.batch_delete", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TaskSharingClientRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TaskSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity TaskSharingClientRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted TaskSharingClientRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TaskSharingClientRelations/batch-modify": {"post": {"description": "Create or update an batch of TaskSharingClientRelations", "operationId": "TaskSharingClientRelations.batch_create_or_update", "summary": "TaskSharingClientRelations.batch_create_or_update", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TaskSharingClientRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TaskSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new TaskSharingClientRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchTaskSharingClientRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated TaskSharingClientRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TaskSharingClientRelations/batch-restore": {"post": {"description": "Restores TaskSharingClientRelations with given list of ids", "operationId": "TaskSharingClientRelations.batch_restore", "summary": "TaskSharingClientRelations.batch_restore", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TaskSharingClientRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TaskSharingClientRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity TaskSharingClientRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored TaskSharingClientRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TaskSharingSalesUnitRelations/{id}": {"get": {"description": "Returns TaskSharingSalesUnitRelation with given id", "operationId": "TaskSharingSalesUnitRelations.get", "summary": "TaskSharingSalesUnitRelations.get", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of TaskSharingSalesUnitRelation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "TaskSharingSalesUnitRelation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TaskSharingSalesUnitRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes TaskSharingSalesUnitRelation with given id", "operationId": "TaskSharingSalesUnitRelations.delete", "summary": "TaskSharingSalesUnitRelations.delete", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of TaskSharingSalesUnitRelation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of TaskSharingSalesUnitRelation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted TaskSharingSalesUnitRelation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies TaskSharingSalesUnitRelation or TaskSharingSalesUnitRelations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of TaskSharingSalesUnitRelation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of TaskSharingSalesUnitRelation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "TaskSharingSalesUnitRelations.update", "summary": "TaskSharingSalesUnitRelations.update", "tags": ["Activity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateTaskSharingSalesUnitRelationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting TaskSharingSalesUnitRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TaskSharingSalesUnitRelation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TaskSharingSalesUnitRelations": {"get": {"description": "Returns all defined TaskSharingSalesUnitRelations", "operationId": "TaskSharingSalesUnitRelations.list", "summary": "TaskSharingSalesUnitRelations.list", "tags": ["Activity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted TaskSharingSalesUnitRelations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of TaskSharingSalesUnitRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/TaskSharingSalesUnitRelation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new TaskSharingSalesUnitRelation", "operationId": "TaskSharingSalesUnitRelations.create", "summary": "TaskSharingSalesUnitRelations.create", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TaskSharingSalesUnitRelation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new TaskSharingSalesUnitRelation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createTaskSharingSalesUnitRelationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created TaskSharingSalesUnitRelation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TaskSharingSalesUnitRelation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TaskSharingSalesUnitRelations/batch-delete": {"post": {"description": "Removes TaskSharingSalesUnitRelations with given list of ids", "operationId": "TaskSharingSalesUnitRelations.batch_delete", "summary": "TaskSharingSalesUnitRelations.batch_delete", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TaskSharingSalesUnitRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TaskSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity TaskSharingSalesUnitRelation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted TaskSharingSalesUnitRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TaskSharingSalesUnitRelations/batch-modify": {"post": {"description": "Create or update an batch of TaskSharingSalesUnitRelations", "operationId": "TaskSharingSalesUnitRelations.batch_create_or_update", "summary": "TaskSharingSalesUnitRelations.batch_create_or_update", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TaskSharingSalesUnitRelations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TaskSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new TaskSharingSalesUnitRelation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchTaskSharingSalesUnitRelationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated TaskSharingSalesUnitRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TaskSharingSalesUnitRelations/batch-restore": {"post": {"description": "Restores TaskSharingSalesUnitRelations with given list of ids", "operationId": "TaskSharingSalesUnitRelations.batch_restore", "summary": "TaskSharingSalesUnitRelations.batch_restore", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TaskSharingSalesUnitRelations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TaskSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity TaskSharingSalesUnitRelation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored TaskSharingSalesUnitRelation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TaskTypes/{id}": {"get": {"description": "Returns TaskType with given id", "operationId": "TaskTypes.get", "summary": "TaskTypes.get", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of TaskType to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "TaskType data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TaskType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes TaskType with given id", "operationId": "TaskTypes.delete", "summary": "TaskTypes.delete", "tags": ["Activity"], "parameters": [{"name": "id", "in": "path", "description": "ID of TaskType to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of TaskType on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted TaskType", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies TaskType or TaskTypes with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of TaskType to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of TaskType on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "TaskTypes.update", "summary": "TaskTypes.update", "tags": ["Activity"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateTaskTypeInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting TaskType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TaskType"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TaskTypes": {"get": {"description": "Returns all defined TaskTypes", "operationId": "TaskTypes.list", "summary": "TaskTypes.list", "tags": ["Activity"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted TaskTypes are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of TaskTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/TaskType"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new TaskType", "operationId": "TaskTypes.create", "summary": "TaskTypes.create", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TaskType on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new TaskType", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createTaskTypeInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created TaskType", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TaskType"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TaskTypes/batch-delete": {"post": {"description": "Removes TaskTypes with given list of ids", "operationId": "TaskTypes.batch_delete", "summary": "TaskTypes.batch_delete", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TaskTypes on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TaskTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity TaskType to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted TaskType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TaskTypes/batch-modify": {"post": {"description": "Create or update an batch of TaskTypes", "operationId": "TaskTypes.batch_create_or_update", "summary": "TaskTypes.batch_create_or_update", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TaskTypes on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TaskTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new TaskType", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchTaskTypeInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated TaskTypes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TaskTypes/batch-restore": {"post": {"description": "Restores TaskTypes with given list of ids", "operationId": "TaskTypes.batch_restore", "summary": "TaskTypes.batch_restore", "tags": ["Activity"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TaskTypes on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TaskTypes. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity TaskType to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored TaskType.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TextMessages/{id}": {"get": {"description": "Returns TextMessage with given id", "operationId": "TextMessages.get", "summary": "TextMessages.get", "tags": ["Text"], "parameters": [{"name": "id", "in": "path", "description": "ID of TextMessage to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "TextMessage data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TextMessage"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes TextMessage with given id", "operationId": "TextMessages.delete", "summary": "TextMessages.delete", "tags": ["Text"], "parameters": [{"name": "id", "in": "path", "description": "ID of TextMessage to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of TextMessage on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted TextMessage", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies TextMessage or TextMessages with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of TextMessage to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of TextMessage on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "TextMessages.update", "summary": "TextMessages.update", "tags": ["Text"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateTextMessageInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting TextMessage", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TextMessage"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TextMessages": {"get": {"description": "Returns all defined TextMessages", "operationId": "TextMessages.list", "summary": "TextMessages.list", "tags": ["Text"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted TextMessages are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of TextMessages", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/TextMessage"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new TextMessage", "operationId": "TextMessages.create", "summary": "TextMessages.create", "tags": ["Text"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TextMessage on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new TextMessage", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createTextMessageInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created TextMessage", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TextMessage"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TextMessages/batch-delete": {"post": {"description": "Removes TextMessages with given list of ids", "operationId": "TextMessages.batch_delete", "summary": "TextMessages.batch_delete", "tags": ["Text"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TextMessages on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TextMessages. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity TextMessage to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted TextMessage.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TextMessages/batch-modify": {"post": {"description": "Create or update an batch of TextMessages", "operationId": "TextMessages.batch_create_or_update", "summary": "TextMessages.batch_create_or_update", "tags": ["Text"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TextMessages on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TextMessages. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new TextMessage", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchTextMessageInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated TextMessages", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TextMessages/batch-restore": {"post": {"description": "Restores TextMessages with given list of ids", "operationId": "TextMessages.batch_restore", "summary": "TextMessages.batch_restore", "tags": ["Text"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TextMessages on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TextMessages. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity TextMessage to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored TextMessage.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TextMessageConversations/{id}": {"get": {"description": "Returns TextMessageConversation with given id", "operationId": "TextMessageConversations.get", "summary": "TextMessageConversations.get", "tags": ["Text"], "parameters": [{"name": "id", "in": "path", "description": "ID of TextMessageConversation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "TextMessageConversation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TextMessageConversation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes TextMessageConversation with given id", "operationId": "TextMessageConversations.delete", "summary": "TextMessageConversations.delete", "tags": ["Text"], "parameters": [{"name": "id", "in": "path", "description": "ID of TextMessageConversation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of TextMessageConversation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted TextMessageConversation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies TextMessageConversation or TextMessageConversations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of TextMessageConversation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of TextMessageConversation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "TextMessageConversations.update", "summary": "TextMessageConversations.update", "tags": ["Text"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateTextMessageConversationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting TextMessageConversation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TextMessageConversation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TextMessageConversations": {"get": {"description": "Returns all defined TextMessageConversations", "operationId": "TextMessageConversations.list", "summary": "TextMessageConversations.list", "tags": ["Text"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted TextMessageConversations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of TextMessageConversations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/TextMessageConversation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new TextMessageConversation", "operationId": "TextMessageConversations.create", "summary": "TextMessageConversations.create", "tags": ["Text"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TextMessageConversation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new TextMessageConversation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createTextMessageConversationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created TextMessageConversation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TextMessageConversation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TextMessageConversations/batch-delete": {"post": {"description": "Removes TextMessageConversations with given list of ids", "operationId": "TextMessageConversations.batch_delete", "summary": "TextMessageConversations.batch_delete", "tags": ["Text"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TextMessageConversations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TextMessageConversations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity TextMessageConversation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted TextMessageConversation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TextMessageConversations/batch-modify": {"post": {"description": "Create or update an batch of TextMessageConversations", "operationId": "TextMessageConversations.batch_create_or_update", "summary": "TextMessageConversations.batch_create_or_update", "tags": ["Text"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TextMessageConversations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TextMessageConversations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new TextMessageConversation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchTextMessageConversationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated TextMessageConversations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TextMessageConversations/batch-restore": {"post": {"description": "Restores TextMessageConversations with given list of ids", "operationId": "TextMessageConversations.batch_restore", "summary": "TextMessageConversations.batch_restore", "tags": ["Text"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TextMessageConversations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TextMessageConversations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity TextMessageConversation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored TextMessageConversation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TextMessageConversationRelationses/{id}": {"get": {"description": "Returns TextMessageConversationRelations with given id", "operationId": "TextMessageConversationRelationses.get", "summary": "TextMessageConversationRelationses.get", "tags": ["Text"], "parameters": [{"name": "id", "in": "path", "description": "ID of TextMessageConversationRelations to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "TextMessageConversationRelations data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TextMessageConversationRelations"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes TextMessageConversationRelations with given id", "operationId": "TextMessageConversationRelationses.delete", "summary": "TextMessageConversationRelationses.delete", "tags": ["Text"], "parameters": [{"name": "id", "in": "path", "description": "ID of TextMessageConversationRelations to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of TextMessageConversationRelations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted TextMessageConversationRelations", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies TextMessageConversationRelations or TextMessageConversationRelationses with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of TextMessageConversationRelations to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of TextMessageConversationRelations on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "TextMessageConversationRelationses.update", "summary": "TextMessageConversationRelationses.update", "tags": ["Text"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateTextMessageConversationRelationsInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting TextMessageConversationRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TextMessageConversationRelations"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TextMessageConversationRelationses": {"get": {"description": "Returns all defined TextMessageConversationRelationses", "operationId": "TextMessageConversationRelationses.list", "summary": "TextMessageConversationRelationses.list", "tags": ["Text"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted TextMessageConversationRelationses are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of TextMessageConversationRelationses", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/TextMessageConversationRelations"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new TextMessageConversationRelations", "operationId": "TextMessageConversationRelationses.create", "summary": "TextMessageConversationRelationses.create", "tags": ["Text"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TextMessageConversationRelations on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new TextMessageConversationRelations", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createTextMessageConversationRelationsInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created TextMessageConversationRelations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/TextMessageConversationRelations"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TextMessageConversationRelationses/batch-delete": {"post": {"description": "Removes TextMessageConversationRelationses with given list of ids", "operationId": "TextMessageConversationRelationses.batch_delete", "summary": "TextMessageConversationRelationses.batch_delete", "tags": ["Text"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TextMessageConversationRelationses on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TextMessageConversationRelationses. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity TextMessageConversationRelations to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted TextMessageConversationRelations.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TextMessageConversationRelationses/batch-modify": {"post": {"description": "Create or update an batch of TextMessageConversationRelationses", "operationId": "TextMessageConversationRelationses.batch_create_or_update", "summary": "TextMessageConversationRelationses.batch_create_or_update", "tags": ["Text"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TextMessageConversationRelationses on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TextMessageConversationRelationses. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new TextMessageConversationRelations", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchTextMessageConversationRelationsInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated TextMessageConversationRelationses", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/TextMessageConversationRelationses/batch-restore": {"post": {"description": "Restores TextMessageConversationRelationses with given list of ids", "operationId": "TextMessageConversationRelationses.batch_restore", "summary": "TextMessageConversationRelationses.batch_restore", "tags": ["Text"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of TextMessageConversationRelationses on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for TextMessageConversationRelationses. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity TextMessageConversationRelations to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored TextMessageConversationRelations.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Timeframes/{id}": {"get": {"description": "Returns Timeframe with given id", "operationId": "Timeframes.get", "summary": "Timeframes.get", "tags": ["Timeframe"], "parameters": [{"name": "id", "in": "path", "description": "ID of Timeframe to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Timeframe data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Timeframe"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Timeframes": {"get": {"description": "Returns all defined Timeframes", "operationId": "Timeframes.list", "summary": "Timeframes.list", "tags": ["Timeframe"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Timeframes are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Timeframes", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Timeframe"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Translations/{id}": {"get": {"description": "Returns Translation with given id", "operationId": "Translations.get", "summary": "Translations.get", "tags": ["Translation"], "parameters": [{"name": "id", "in": "path", "description": "ID of Translation to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Translation data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Translation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Translation with given id", "operationId": "Translations.delete", "summary": "Translations.delete", "tags": ["Translation"], "parameters": [{"name": "id", "in": "path", "description": "ID of Translation to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Translation on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Translation", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Translation or Translations with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Translation to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Translation on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Translations.update", "summary": "Translations.update", "tags": ["Translation"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateTranslationInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Translation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Translation"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Translations": {"get": {"description": "Returns all defined Translations", "operationId": "Translations.list", "summary": "Translations.list", "tags": ["Translation"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Translations are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Translations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Translation"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Translation", "operationId": "Translations.create", "summary": "Translations.create", "tags": ["Translation"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Translation on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Translation", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createTranslationInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Translation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Translation"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Translations/batch-delete": {"post": {"description": "Removes Translations with given list of ids", "operationId": "Translations.batch_delete", "summary": "Translations.batch_delete", "tags": ["Translation"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Translations on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Translations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Translation to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Translation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Translations/batch-modify": {"post": {"description": "Create or update an batch of Translations", "operationId": "Translations.batch_create_or_update", "summary": "Translations.batch_create_or_update", "tags": ["Translation"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Translations on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Translations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Translation", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchTranslationInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Translations", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Translations/batch-restore": {"post": {"description": "Restores Translations with given list of ids", "operationId": "Translations.batch_restore", "summary": "Translations.batch_restore", "tags": ["Translation"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Translations on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Translations. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Translation to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Translation.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Types/{id}": {"get": {"description": "Returns Type with given id", "operationId": "Types.get", "summary": "Types.get", "tags": ["Type"], "parameters": [{"name": "id", "in": "path", "description": "ID of Type to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Type data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Type"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Types": {"get": {"description": "Returns all defined Types", "operationId": "Types.list", "summary": "Types.list", "tags": ["Type"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Types are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Types", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Type"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/UnsubscribedPhones/{id}": {"get": {"description": "Returns UnsubscribedPhone with given id", "operationId": "UnsubscribedPhones.get", "summary": "UnsubscribedPhones.get", "tags": ["Unsubscribed"], "parameters": [{"name": "id", "in": "path", "description": "ID of UnsubscribedPhone to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "UnsubscribedPhone data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/UnsubscribedPhone"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes UnsubscribedPhone with given id", "operationId": "UnsubscribedPhones.delete", "summary": "UnsubscribedPhones.delete", "tags": ["Unsubscribed"], "parameters": [{"name": "id", "in": "path", "description": "ID of UnsubscribedPhone to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of UnsubscribedPhone on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted UnsubscribedPhone", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies UnsubscribedPhone or UnsubscribedPhones with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of UnsubscribedPhone to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of UnsubscribedPhone on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "UnsubscribedPhones.update", "summary": "UnsubscribedPhones.update", "tags": ["Unsubscribed"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateUnsubscribedPhoneInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting UnsubscribedPhone", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/UnsubscribedPhone"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/UnsubscribedPhones": {"get": {"description": "Returns all defined UnsubscribedPhones", "operationId": "UnsubscribedPhones.list", "summary": "UnsubscribedPhones.list", "tags": ["Unsubscribed"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted UnsubscribedPhones are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of UnsubscribedPhones", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/UnsubscribedPhone"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new UnsubscribedPhone", "operationId": "UnsubscribedPhones.create", "summary": "UnsubscribedPhones.create", "tags": ["Unsubscribed"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of UnsubscribedPhone on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new UnsubscribedPhone", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createUnsubscribedPhoneInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created UnsubscribedPhone", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/UnsubscribedPhone"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/UnsubscribedPhones/batch-delete": {"post": {"description": "Removes UnsubscribedPhones with given list of ids", "operationId": "UnsubscribedPhones.batch_delete", "summary": "UnsubscribedPhones.batch_delete", "tags": ["Unsubscribed"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of UnsubscribedPhones on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for UnsubscribedPhones. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity UnsubscribedPhone to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted UnsubscribedPhone.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/UnsubscribedPhones/batch-modify": {"post": {"description": "Create or update an batch of UnsubscribedPhones", "operationId": "UnsubscribedPhones.batch_create_or_update", "summary": "UnsubscribedPhones.batch_create_or_update", "tags": ["Unsubscribed"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of UnsubscribedPhones on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for UnsubscribedPhones. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new UnsubscribedPhone", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchUnsubscribedPhoneInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated UnsubscribedPhones", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/UnsubscribedPhones/batch-restore": {"post": {"description": "Restores UnsubscribedPhones with given list of ids", "operationId": "UnsubscribedPhones.batch_restore", "summary": "UnsubscribedPhones.batch_restore", "tags": ["Unsubscribed"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of UnsubscribedPhones on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for UnsubscribedPhones. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity UnsubscribedPhone to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored UnsubscribedPhone.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Webhooks/{id}": {"get": {"description": "Returns Webhook with given id", "operationId": "Webhooks.get", "summary": "Webhooks.get", "tags": ["Webhook"], "parameters": [{"name": "id", "in": "path", "description": "ID of Webhook to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Webhook data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Webhook"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Webhook with given id", "operationId": "Webhooks.delete", "summary": "Webhooks.delete", "tags": ["Webhook"], "parameters": [{"name": "id", "in": "path", "description": "ID of Webhook to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Webhook on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Webhook", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Webhook or Webhooks with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Webhook to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Webhook on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Webhooks.update", "summary": "Webhooks.update", "tags": ["Webhook"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateWebhookInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Webhook", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Webhook"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Webhooks": {"get": {"description": "Returns all defined Webhooks", "operationId": "Webhooks.list", "summary": "Webhooks.list", "tags": ["Webhook"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Webhooks are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Webhooks", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Webhook"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Webhook", "operationId": "Webhooks.create", "summary": "Webhooks.create", "tags": ["Webhook"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Webhook on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Webhook", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createWebhookInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Webhook", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Webhook"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Webhooks/batch-delete": {"post": {"description": "Removes Webhooks with given list of ids", "operationId": "Webhooks.batch_delete", "summary": "Webhooks.batch_delete", "tags": ["Webhook"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Webhooks on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Webhooks. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Webhook to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Webhook.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Webhooks/batch-modify": {"post": {"description": "Create or update an batch of Webhooks", "operationId": "Webhooks.batch_create_or_update", "summary": "Webhooks.batch_create_or_update", "tags": ["Webhook"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Webhooks on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Webhooks. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Webhook", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchWebhookInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Webhooks", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Webhooks/batch-restore": {"post": {"description": "Restores Webhooks with given list of ids", "operationId": "Webhooks.batch_restore", "summary": "Webhooks.batch_restore", "tags": ["Webhook"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Webhooks on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Webhooks. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Webhook to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Webhook.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/WebhookEvents/{id}": {"get": {"description": "Returns WebhookEvent with given id", "operationId": "WebhookEvents.get", "summary": "WebhookEvents.get", "tags": ["Webhook"], "parameters": [{"name": "id", "in": "path", "description": "ID of WebhookEvent to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "WebhookEvent data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/WebhookEvent"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes WebhookEvent with given id", "operationId": "WebhookEvents.delete", "summary": "WebhookEvents.delete", "tags": ["Webhook"], "parameters": [{"name": "id", "in": "path", "description": "ID of WebhookEvent to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of WebhookEvent on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted WebhookEvent", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies WebhookEvent or WebhookEvents with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of WebhookEvent to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of WebhookEvent on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "WebhookEvents.update", "summary": "WebhookEvents.update", "tags": ["Webhook"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateWebhookEventInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting WebhookEvent", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/WebhookEvent"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/WebhookEvents": {"get": {"description": "Returns all defined WebhookEvents", "operationId": "WebhookEvents.list", "summary": "WebhookEvents.list", "tags": ["Webhook"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted WebhookEvents are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of WebhookEvents", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/WebhookEvent"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new WebhookEvent", "operationId": "WebhookEvents.create", "summary": "WebhookEvents.create", "tags": ["Webhook"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of WebhookEvent on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new WebhookEvent", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createWebhookEventInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created WebhookEvent", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/WebhookEvent"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/WebhookEvents/batch-delete": {"post": {"description": "Removes WebhookEvents with given list of ids", "operationId": "WebhookEvents.batch_delete", "summary": "WebhookEvents.batch_delete", "tags": ["Webhook"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of WebhookEvents on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for WebhookEvents. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity WebhookEvent to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted WebhookEvent.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/WebhookEvents/batch-modify": {"post": {"description": "Create or update an batch of WebhookEvents", "operationId": "WebhookEvents.batch_create_or_update", "summary": "WebhookEvents.batch_create_or_update", "tags": ["Webhook"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of WebhookEvents on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for WebhookEvents. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new WebhookEvent", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchWebhookEventInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated WebhookEvents", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/WebhookEvents/batch-restore": {"post": {"description": "Restores WebhookEvents with given list of ids", "operationId": "WebhookEvents.batch_restore", "summary": "WebhookEvents.batch_restore", "tags": ["Webhook"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of WebhookEvents on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for WebhookEvents. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity WebhookEvent to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored WebhookEvent.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Webresources/{id}": {"get": {"description": "Returns Webresource with given id", "operationId": "Webresources.get", "summary": "Webresources.get", "tags": ["Webresource"], "parameters": [{"name": "id", "in": "path", "description": "ID of Webresource to retrieve", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Webresource data", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Webresource"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "delete": {"description": "Removes Webresource with given id", "operationId": "Webresources.delete", "summary": "Webresources.delete", "tags": ["Webresource"], "parameters": [{"name": "id", "in": "path", "description": "ID of Webresource to delete", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Webresource on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "Removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"description": "id of deleted Webresource", "type": "string", "format": "uuid"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "patch": {"description": "Modifies Webresource or Webresources with given id(s)", "parameters": [{"name": "id", "in": "path", "description": "ID of Webresource to update", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "validation-level", "in": "query", "description": "Specify validation level of Webresource on update. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "operationId": "Webresources.update", "summary": "Webresources.update", "tags": ["Webresource"], "requestBody": {"description": "id(s) of modified item(s) and fields to modify", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateWebresourceInput"}}}}, "responses": {"200": {"description": "Modification confirmation. Returns resulting Webresource", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Webresource"}}}}}}, "404": {"description": "Sent when invalid ID is given", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Webresources": {"get": {"description": "Returns all defined Webresources", "operationId": "Webresources.list", "summary": "Webresources.list", "tags": ["Webresource"], "parameters": [{"name": "include-deleted", "in": "query", "description": "if enabled, deleted Webresources are returned as well", "required": false, "schema": {"type": "boolean"}}, {"name": "first", "in": "query", "description": "Number of entities to return from beginning of the result set. Max: 100. Default: 30", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "last", "in": "query", "description": "Return only the \"last\" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.", "required": false, "schema": {"type": "integer", "format": "int32"}}, {"name": "before", "in": "query", "description": "Cursor until which to take entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "after", "in": "query", "description": "Cursor after which to start taking entities to result set.", "required": false, "schema": {"type": "string"}}, {"name": "expand", "in": "query", "description": "Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.", "required": false, "example": "expand=owner,sales_unit,account_relations.account", "schema": {"type": "string"}}, {"name": "order-by", "in": "query", "description": "Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.", "example": "order-by=created,-modified", "required": false, "schema": {"type": "string"}}, {"name": "filter", "in": "query", "description": "Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.", "example": "filter[name]=Example", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "filter-op", "in": "query", "description": "Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].", "example": "filter-op[name]=eq", "required": false, "schema": {"type": "object"}, "style": "deepObject", "allowReserved": true}, {"name": "load-only", "in": "query", "description": "Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.", "required": false, "example": "load-only=id,name,owner.id", "schema": {"type": "string"}}], "responses": {"200": {"description": "list of Webresources", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/Webresource"}}, "page_info": {"type": "object", "properties": {"start_cursor": {"type": "string", "example": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==", "description": "Start cursor of result set."}, "end_cursor": {"type": "string", "example": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==", "description": "End cursor of result set."}, "has_previous_page": {"type": "boolean", "example": true, "description": "If result set has previous page (if yes, use start_cursor value in before parameter to load it)."}, "has_next_page": {"type": "boolean", "example": true, "description": "If result set has next page (if yes, use end_cursor value in after parameter to load it)."}}, "description": "Page info result set. Please note it is returned only when legacy limit & offset parameters are not used."}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}, "post": {"description": "Creates new Webresource", "operationId": "Webresources.create", "summary": "Webresources.create", "tags": ["Webresource"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Webresource on create. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Webresource", "required": true, "content": {"application / json": {"schema": {"$ref": "#/components/schemas/createWebresourceInput"}}}}, "responses": {"201": {"description": "Creation confirmation. Returns created Webresource", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"$ref": "#/components/schemas/Webresource"}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Webresources/batch-delete": {"post": {"description": "Removes Webresources with given list of ids", "operationId": "Webresources.batch_delete", "summary": "Webresources.batch_delete", "tags": ["Webresource"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Webresources on delete. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Webresources. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to delete.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Webresource to delete.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch removal confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of deleted Webresource.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Webresources/batch-modify": {"post": {"description": "Create or update an batch of Webresources", "operationId": "Webresources.batch_create_or_update", "summary": "Webresources.batch_create_or_update", "tags": ["Webresource"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Webresources on change. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Webresources. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "data of new Webresource", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/batchWebresourceInput"}}}}}, "responses": {"200": {"description": "Creation confirmation. Returns a list of created / updated Webresources", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "And ID of created / updated entity.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}, "/entities/Webresources/batch-restore": {"post": {"description": "Restores Webresources with given list of ids", "operationId": "Webresources.batch_restore", "summary": "Webresources.batch_restore", "tags": ["Webresource"], "parameters": [{"name": "validation-level", "in": "query", "description": "Specify validation level of Webresources on restore. Use them as bit mask: 0 - validate each field on entity,\n2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,\n16 - allows to set entity on deleted relationship.", "schema": {"type": "integer", "format": "int32"}}, {"name": "rollback-method", "in": "query", "description": "Specify rollback method for Webresources. 0 - rollback all, 1 - rollback only failed records.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "List of ids to restore.", "required": true, "content": {"application / json": {"schema": {"type": "array", "items": {"type": "string", "description": "An id of entity Webresource to restore.", "format": "uuid"}}}}}, "responses": {"200": {"description": "Batch restoration confirmation", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean", "example": true, "description": "True when response succeeded, false on error."}, "data": {"type": "array", "items": {"oneOf": [{"type": "string", "description": "An id of restored Webresource.", "format": "uuid"}, {"$ref": "#/components/schemas/Error"}]}}}}}}}, "500": {"description": "unexpected error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}}}}, "tags": [{"name": "Account"}, {"name": "Activity"}, {"name": "Api"}, {"name": "Approval"}, {"name": "Call"}, {"name": "Chat"}, {"name": "Client"}, {"name": "Company Email"}, {"name": "Contact"}, {"name": "Country"}, {"name": "Currency"}, {"name": "Custom Entity"}, {"name": "Data"}, {"name": "Document"}, {"name": "Email"}, {"name": "Email Sequence"}, {"name": "Field"}, {"name": "Forecast"}, {"name": "Form"}, {"name": "Import"}, {"name": "Interface"}, {"name": "Lead"}, {"name": "Lead & Opportunity"}, {"name": "MasterRight"}, {"name": "Media"}, {"name": "Memo"}, {"name": "Message"}, {"name": "Note"}, {"name": "Online"}, {"name": "Opportunity"}, {"name": "Phone"}, {"name": "Pipeline"}, {"name": "Process"}, {"name": "Product"}, {"name": "Product Line Items"}, {"name": "Profile"}, {"name": "Project"}, {"name": "Quote"}, {"name": "Report"}, {"name": "SalesRole"}, {"name": "SalesUnit"}, {"name": "Step"}, {"name": "Tag"}, {"name": "Target"}, {"name": "Text"}, {"name": "Timeframe"}, {"name": "Translation"}, {"name": "Type"}, {"name": "Unsubscribed"}, {"name": "Webhook"}, {"name": "Webresource"}], "components": {"schemas": {"Error": {"properties": {"http_status": {"description": "HTTP status code", "type": "integer", "example": 400}, "code": {"description": "Internal API error code", "type": "integer", "example": 117}, "name": {"description": "Name of the API error", "type": "string", "example": "ERROR_PARAMETER_INVALID"}, "message": {"description": "Description of the API error", "type": "string"}, "success": {"description": "Always false on error.", "type": "boolean", "example": false}}, "required": ["success", "http_status"]}, "Account": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time."}, "account_type": {"type": "string", "format": "uri", "description": "Account type that classifies this account. Account types are configurable per team space and drive which form, fields and pipelines apply.\n\nRelation to AccountType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountType' object for properties."}, "currency_exchange_rates_list": {"type": "string", "format": "uri", "description": "Currency exchange rate list used to convert monetary fields linked to this account. Empty to inherit the team space default.\n\nRelation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRatesList' object for properties."}, "customer_type": {"type": "string", "format": "uri", "description": "Customer category (e.g. Lead, Prospect, Customer). Configurable per team space.\n\nRelation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties."}, "industry": {"type": "string", "format": "uri", "description": "Industry the account operates in. Configurable per team space.\n\nRelation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "Sales user who owns this account.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "parent_account": {"type": "string", "format": "uri", "description": "Parent account in a corporate hierarchy. Empty for top-level accounts.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "parent_account_relation_type": {"type": "string", "format": "uri", "description": "Type of relationship to the parent account (e.g. subsidiary, branch). Required when parent_account is set.\n\nRelation to ParentAccountRelationType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ParentAccountRelationType' object for properties."}, "picture": {"type": "string", "format": "uri", "description": "Profile picture or company logo associated with the account.\n\nRelation to CloudObject. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObject' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit this account is assigned to. Determines which team members can see the record under unit-based sharing.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "account_class": {"type": "integer", "description": "Manual classification grade assigned to the account. Used in segmentation and reporting.\n\nInteger enum value: 1 - NoClass, 2 - ClassA, 3 - ClassB, 4 - ClassC, 5 - ClassD", "example": 1, "enum": [1, 2, 3, 4, 5]}, "account_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account type assigned to this account."}, "address": {"type": "string", "example": "string", "description": "Street address of the account."}, "city": {"type": "string", "example": "string", "description": "City of the account address."}, "comments": {"type": "string", "example": "string", "description": "Free-form notes describing the account."}, "country": {"type": "string", "example": "string", "description": "Country of the account address."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this account."}, "customer_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the customer type."}, "email1": {"type": "string", "example": "string", "description": "Primary email address of the account. Used as default recipient for emails sent from Coevera."}, "email2": {"type": "string", "example": "string", "description": "Additional email address."}, "email3": {"type": "string", "example": "string", "description": "Additional email address."}, "email4": {"type": "string", "example": "string", "description": "Additional email address."}, "email5": {"type": "string", "example": "string", "description": "Additional email address."}, "health_category": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Coarser bucket of health_status used for grouping and reporting. Read-only."}, "health_status": {"type": "integer", "format": "int32", "example": 1, "description": "Computed entity-health state (e.g. healthy, at-risk). Read-only; recalculated by Coevera when relevant fields change."}, "home_page": {"type": "string", "example": "string", "description": "Website URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled."}, "industry_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the industry classification."}, "is_archived": {"type": "boolean", "example": false, "description": "True when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated."}, "last_ai_account_hierarchy_applied": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Time when an AI-suggested account hierarchy was last applied to this account."}, "last_ai_org_chart_applied": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Time when an AI-suggested org chart was last applied to this account."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account owner."}, "parent_account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent account."}, "parent_account_relation_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent-account relationship type."}, "phone1": {"type": "string", "example": "string", "description": "Primary phone number of the account. Used as default target for click-to-call."}, "phone2": {"type": "string", "example": "string", "description": "Additional phone number."}, "phone3": {"type": "string", "example": "string", "description": "Additional phone number."}, "phone4": {"type": "string", "example": "string", "description": "Additional phone number."}, "phone5": {"type": "string", "example": "string", "description": "Additional phone number."}, "picture_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the profile picture document."}, "quick_parent_account_name": {"type": "string", "example": "string", "description": "Free-text parent-account name used when the parent has not been linked to an actual Account record. Lets integrators note the relationship without creating a separate parent Account."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "state_province": {"type": "string", "example": "string", "description": "State or province of the account address."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "zip_code": {"type": "string", "example": "string", "description": "ZIP or postal code of the account address."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "formatted_name": {"type": "string", "example": "string", "description": "Display version of the account name, used in lists and references."}, "social_media": {"type": "string", "format": "uri", "description": "Social network profiles linked to this account (e.g. LinkedIn, Facebook).\n\nRelation to AccountSocialRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountSocialRelation' object for properties."}, "sharing_units": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to AccountSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountSharingSalesUnitRelation' object for properties."}, "description": "Sales units that have been granted shared access to this account. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to AccountSharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountSharingClientRelation' object for properties."}, "description": "Users that have been granted shared access to this account. Editable only when share_mode allows user sharing."}, "documents": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties."}, "description": "Documents linked to this account."}, "is_favorite": {"type": "boolean", "example": false, "description": "True when the current authenticated user has marked this account as favorite. Per-user."}, "is_unsubscribed": {"type": "boolean", "example": false, "description": "If account has any unsubscribed email."}, "tags": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to TagRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TagRelation' object for properties."}, "description": "Tag labels applied to this account."}, "static_profiles": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ProfileRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProfileRelation' object for properties."}, "description": "Saved view profiles this account currently matches."}, "health": {"type": "object", "description": "Composite entity-health summary, combining current and previous state with last-calculation metadata. Read-only; computed by Coevera."}, "modified_by_user": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera."}}, "required": ["is_delete_protected", "id", "account_type", "owner", "unit", "name", "owner_id", "formatted_name", "is_favorite"]}, "createAccountInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time."}, "picture": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Profile picture or company logo associated with the account.\n\nRelation to CloudObject, see: 'createCloudObjectInput' object for properties."}, "account_class": {"type": "integer", "description": "Manual classification grade assigned to the account. Used in segmentation and reporting.\n\nInteger enum value: 1 - NoClass, 2 - ClassA, 3 - ClassB, 4 - ClassC, 5 - ClassD", "example": 1, "enum": [1, 2, 3, 4, 5]}, "account_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account type assigned to this account."}, "address": {"type": "string", "example": "string", "description": "Street address of the account."}, "city": {"type": "string", "example": "string", "description": "City of the account address."}, "comments": {"type": "string", "example": "string", "description": "Free-form notes describing the account."}, "country": {"type": "string", "example": "string", "description": "Country of the account address."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this account."}, "customer_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the customer type."}, "email1": {"type": "string", "example": "string", "description": "Primary email address of the account. Used as default recipient for emails sent from Coevera."}, "email2": {"type": "string", "example": "string", "description": "Additional email address."}, "email3": {"type": "string", "example": "string", "description": "Additional email address."}, "email4": {"type": "string", "example": "string", "description": "Additional email address."}, "email5": {"type": "string", "example": "string", "description": "Additional email address."}, "home_page": {"type": "string", "example": "string", "description": "Website URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled."}, "industry_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the industry classification."}, "is_archived": {"type": "boolean", "example": false, "description": "True when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated."}, "last_ai_account_hierarchy_applied": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Time when an AI-suggested account hierarchy was last applied to this account."}, "last_ai_org_chart_applied": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Time when an AI-suggested org chart was last applied to this account."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account owner."}, "parent_account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent account."}, "parent_account_relation_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent-account relationship type."}, "phone1": {"type": "string", "example": "string", "description": "Primary phone number of the account. Used as default target for click-to-call."}, "phone2": {"type": "string", "example": "string", "description": "Additional phone number."}, "phone3": {"type": "string", "example": "string", "description": "Additional phone number."}, "phone4": {"type": "string", "example": "string", "description": "Additional phone number."}, "phone5": {"type": "string", "example": "string", "description": "Additional phone number."}, "picture_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the profile picture document."}, "quick_parent_account_name": {"type": "string", "example": "string", "description": "Free-text parent-account name used when the parent has not been linked to an actual Account record. Lets integrators note the relationship without creating a separate parent Account."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "state_province": {"type": "string", "example": "string", "description": "State or province of the account address."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "zip_code": {"type": "string", "example": "string", "description": "ZIP or postal code of the account address."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "social_media": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Social network profiles linked to this account (e.g. LinkedIn, Facebook).\n\nRelation to AccountSocialRelation, see: 'createAccountSocialRelationInput' object for properties."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AccountSharingSalesUnitRelation, see: 'createAccountSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this account. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AccountSharingClientRelation, see: 'createAccountSharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this account. Editable only when share_mode allows user sharing."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this account."}, "is_unsubscribed": {"type": "boolean", "example": false, "description": "If account has any unsubscribed email."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'createTagRelationInput' object for properties."}, "description": "Tag labels applied to this account."}, "static_profiles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProfileRelation, see: 'createProfileRelationInput' object for properties."}, "description": "Saved view profiles this account currently matches."}}, "required": ["name", "owner_id"]}, "updateAccountInput": {"properties": {"created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time."}, "picture": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Profile picture or company logo associated with the account.\n\nRelation to CloudObject, see: 'updateCloudObjectInput' object for properties."}, "account_class": {"type": "integer", "description": "Manual classification grade assigned to the account. Used in segmentation and reporting.\n\nInteger enum value: 1 - NoClass, 2 - ClassA, 3 - ClassB, 4 - ClassC, 5 - ClassD", "example": 1, "enum": [1, 2, 3, 4, 5]}, "account_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account type assigned to this account."}, "address": {"type": "string", "example": "string", "description": "Street address of the account."}, "city": {"type": "string", "example": "string", "description": "City of the account address."}, "comments": {"type": "string", "example": "string", "description": "Free-form notes describing the account."}, "country": {"type": "string", "example": "string", "description": "Country of the account address."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this account."}, "customer_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the customer type."}, "email1": {"type": "string", "example": "string", "description": "Primary email address of the account. Used as default recipient for emails sent from Coevera."}, "email2": {"type": "string", "example": "string", "description": "Additional email address."}, "email3": {"type": "string", "example": "string", "description": "Additional email address."}, "email4": {"type": "string", "example": "string", "description": "Additional email address."}, "email5": {"type": "string", "example": "string", "description": "Additional email address."}, "home_page": {"type": "string", "example": "string", "description": "Website URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled."}, "industry_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the industry classification."}, "is_archived": {"type": "boolean", "example": false, "description": "True when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated."}, "last_ai_account_hierarchy_applied": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Time when an AI-suggested account hierarchy was last applied to this account."}, "last_ai_org_chart_applied": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Time when an AI-suggested org chart was last applied to this account."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account owner."}, "parent_account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent account."}, "parent_account_relation_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent-account relationship type."}, "phone1": {"type": "string", "example": "string", "description": "Primary phone number of the account. Used as default target for click-to-call."}, "phone2": {"type": "string", "example": "string", "description": "Additional phone number."}, "phone3": {"type": "string", "example": "string", "description": "Additional phone number."}, "phone4": {"type": "string", "example": "string", "description": "Additional phone number."}, "phone5": {"type": "string", "example": "string", "description": "Additional phone number."}, "picture_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the profile picture document."}, "quick_parent_account_name": {"type": "string", "example": "string", "description": "Free-text parent-account name used when the parent has not been linked to an actual Account record. Lets integrators note the relationship without creating a separate parent Account."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "state_province": {"type": "string", "example": "string", "description": "State or province of the account address."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "zip_code": {"type": "string", "example": "string", "description": "ZIP or postal code of the account address."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "social_media": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Social network profiles linked to this account (e.g. LinkedIn, Facebook).\n\nRelation to AccountSocialRelation, see: 'updateAccountSocialRelationInput' object for properties."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AccountSharingSalesUnitRelation, see: 'updateAccountSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this account. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AccountSharingClientRelation, see: 'updateAccountSharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this account. Editable only when share_mode allows user sharing."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this account."}, "is_unsubscribed": {"type": "boolean", "example": false, "description": "If account has any unsubscribed email."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'updateTagRelationInput' object for properties."}, "description": "Tag labels applied to this account."}, "static_profiles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProfileRelation, see: 'updateProfileRelationInput' object for properties."}, "description": "Saved view profiles this account currently matches."}}}, "batchAccountInput": {"properties": {"created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time."}, "picture": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Profile picture or company logo associated with the account.\n\nRelation to CloudObject, see: 'updateCloudObjectInput' object for properties."}, "account_class": {"type": "integer", "description": "Manual classification grade assigned to the account. Used in segmentation and reporting.\n\nInteger enum value: 1 - NoClass, 2 - ClassA, 3 - ClassB, 4 - ClassC, 5 - ClassD", "example": 1, "enum": [1, 2, 3, 4, 5]}, "account_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account type assigned to this account."}, "address": {"type": "string", "example": "string", "description": "Street address of the account."}, "city": {"type": "string", "example": "string", "description": "City of the account address."}, "comments": {"type": "string", "example": "string", "description": "Free-form notes describing the account."}, "country": {"type": "string", "example": "string", "description": "Country of the account address."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this account."}, "customer_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the customer type."}, "email1": {"type": "string", "example": "string", "description": "Primary email address of the account. Used as default recipient for emails sent from Coevera."}, "email2": {"type": "string", "example": "string", "description": "Additional email address."}, "email3": {"type": "string", "example": "string", "description": "Additional email address."}, "email4": {"type": "string", "example": "string", "description": "Additional email address."}, "email5": {"type": "string", "example": "string", "description": "Additional email address."}, "home_page": {"type": "string", "example": "string", "description": "Website URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled."}, "industry_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the industry classification."}, "is_archived": {"type": "boolean", "example": false, "description": "True when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated."}, "last_ai_account_hierarchy_applied": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Time when an AI-suggested account hierarchy was last applied to this account."}, "last_ai_org_chart_applied": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Time when an AI-suggested org chart was last applied to this account."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account owner."}, "parent_account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent account."}, "parent_account_relation_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent-account relationship type."}, "phone1": {"type": "string", "example": "string", "description": "Primary phone number of the account. Used as default target for click-to-call."}, "phone2": {"type": "string", "example": "string", "description": "Additional phone number."}, "phone3": {"type": "string", "example": "string", "description": "Additional phone number."}, "phone4": {"type": "string", "example": "string", "description": "Additional phone number."}, "phone5": {"type": "string", "example": "string", "description": "Additional phone number."}, "picture_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the profile picture document."}, "quick_parent_account_name": {"type": "string", "example": "string", "description": "Free-text parent-account name used when the parent has not been linked to an actual Account record. Lets integrators note the relationship without creating a separate parent Account."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "state_province": {"type": "string", "example": "string", "description": "State or province of the account address."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "zip_code": {"type": "string", "example": "string", "description": "ZIP or postal code of the account address."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "social_media": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Social network profiles linked to this account (e.g. LinkedIn, Facebook).\n\nRelation to AccountSocialRelation, see: 'updateAccountSocialRelationInput' object for properties."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AccountSharingSalesUnitRelation, see: 'updateAccountSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this account. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AccountSharingClientRelation, see: 'updateAccountSharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this account. Editable only when share_mode allows user sharing."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this account."}, "is_unsubscribed": {"type": "boolean", "example": false, "description": "If account has any unsubscribed email."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'updateTagRelationInput' object for properties."}, "description": "Tag labels applied to this account."}, "static_profiles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProfileRelation, see: 'updateProfileRelationInput' object for properties."}, "description": "Saved view profiles this account currently matches."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "AccountDataExRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account": {"type": "string", "format": "uri", "description": "Account this data relation row belongs to.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "data": {"type": "string", "format": "uri", "description": "Data record holding the additional fields linked to the account.\n\nRelation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "data_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the data record."}, "data_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the data set the linked fields belong to."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "account", "data", "account_id", "data_id", "data_set_id"]}, "AccountKPI": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account": {"type": "string", "format": "uri", "description": "Account this KPI event relates to.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "client": {"type": "string", "format": "uri", "description": "User who triggered the KPI event (e.g. created or archived the account, sent the first email).\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "Account owner at the time the KPI event occurred.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit the triggering user belonged to at the time of the event.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration)."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who triggered the event."}, "kpi": {"type": "integer", "description": "KPI metric this event represents: CreateAccount, FirstEmailSent, LastEmailSent, Archive.\n\nInteger enum value: 1 - CreateAccount, 2 - LastEmailSent, 3 - FirstEmailSent, 4 - Archive", "example": 1, "enum": [1, 2, 3, 4]}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account owner at the time of the event."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "account", "owner", "account_id", "kpi", "owner_id"]}, "createAccountKPIInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration)."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who triggered the event."}, "kpi": {"type": "integer", "description": "KPI metric this event represents: CreateAccount, FirstEmailSent, LastEmailSent, Archive.\n\nInteger enum value: 1 - CreateAccount, 2 - LastEmailSent, 3 - FirstEmailSent, 4 - Archive", "example": 1, "enum": [1, 2, 3, 4]}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account owner at the time of the event."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["account_id", "kpi", "owner_id"]}, "updateAccountKPIInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration)."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who triggered the event."}, "kpi": {"type": "integer", "description": "KPI metric this event represents: CreateAccount, FirstEmailSent, LastEmailSent, Archive.\n\nInteger enum value: 1 - CreateAccount, 2 - LastEmailSent, 3 - FirstEmailSent, 4 - Archive", "example": 1, "enum": [1, 2, 3, 4]}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account owner at the time of the event."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchAccountKPIInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration)."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who triggered the event."}, "kpi": {"type": "integer", "description": "KPI metric this event represents: CreateAccount, FirstEmailSent, LastEmailSent, Archive.\n\nInteger enum value: 1 - CreateAccount, 2 - LastEmailSent, 3 - FirstEmailSent, 4 - Archive", "example": 1, "enum": [1, 2, 3, 4]}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account owner at the time of the event."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "AccountProductPricing": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account": {"type": "string", "format": "uri", "description": "Account that this price override applies to.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "currency": {"type": "string", "format": "uri", "description": "Currency of the override price.\n\nRelation to Currency. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Currency' object for properties."}, "product": {"type": "string", "format": "uri", "description": "Product whose price is overridden for this account.\n\nRelation to Product. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Product' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency."}, "price": {"type": "number", "format": "double", "example": "4.32", "description": "Price applied for this product when sold to this account, in the specified currency."}, "product_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "account", "currency", "product", "account_id", "currency_id", "product_id"]}, "createAccountProductPricingInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency."}, "price": {"type": "number", "format": "double", "example": "4.32", "description": "Price applied for this product when sold to this account, in the specified currency."}, "product_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["account_id", "currency_id", "product_id"]}, "updateAccountProductPricingInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency."}, "price": {"type": "number", "format": "double", "example": "4.32", "description": "Price applied for this product when sold to this account, in the specified currency."}, "product_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchAccountProductPricingInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency."}, "price": {"type": "number", "format": "double", "example": "4.32", "description": "Price applied for this product when sold to this account, in the specified currency."}, "product_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "AccountRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account1": {"type": "string", "format": "uri", "description": "One side of the account-to-account relationship.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "account2": {"type": "string", "format": "uri", "description": "Other side of the account-to-account relationship.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "account1_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the first related account."}, "account2_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the second related account."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "account1", "account2", "account1_id", "account2_id"]}, "createAccountRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account1_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the first related account."}, "account2_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the second related account."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["account1_id", "account2_id"]}, "updateAccountRelationInput": {"properties": {"account1_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the first related account."}, "account2_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the second related account."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchAccountRelationInput": {"properties": {"account1_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the first related account."}, "account2_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the second related account."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "AccountRelationLabel": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_relation": {"type": "string", "format": "uri", "description": "Account relationship being labelled.\n\nRelation to AccountRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountRelation' object for properties."}, "account_relation_type": {"type": "string", "format": "uri", "description": "Type of the relationship (e.g. partner, supplier).\n\nRelation to AccountRelationType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountRelationType' object for properties."}, "account_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account relationship."}, "account_relation_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the relationship type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "account_relation", "account_relation_type", "account_relation_id", "account_relation_type_id"]}, "createAccountRelationLabelInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Account relationship being labelled.\n\nRelation to AccountRelation, see: 'createAccountRelationInput' object for properties."}, "account_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account relationship."}, "account_relation_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the relationship type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["account_relation", "account_relation_id", "account_relation_type_id"]}, "updateAccountRelationLabelInput": {"properties": {"account_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Account relationship being labelled.\n\nRelation to AccountRelation, see: 'updateAccountRelationInput' object for properties."}, "account_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account relationship."}, "account_relation_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the relationship type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchAccountRelationLabelInput": {"properties": {"account_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Account relationship being labelled.\n\nRelation to AccountRelation, see: 'updateAccountRelationInput' object for properties."}, "account_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account relationship."}, "account_relation_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the relationship type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "AccountRelationType": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue."}, "label": {"type": "string", "example": "string", "description": "Display label of the account-to-account relationship type (e.g. Partner, Supplier)."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "color"]}, "createAccountRelationTypeInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue."}, "label": {"type": "string", "example": "string", "description": "Display label of the account-to-account relationship type (e.g. Partner, Supplier)."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["color"]}, "updateAccountRelationTypeInput": {"properties": {"color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue."}, "label": {"type": "string", "example": "string", "description": "Display label of the account-to-account relationship type (e.g. Partner, Supplier)."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchAccountRelationTypeInput": {"properties": {"color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue."}, "label": {"type": "string", "example": "string", "description": "Display label of the account-to-account relationship type (e.g. Partner, Supplier)."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "AccountRole": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the role label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue."}, "label": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "color", "label"]}, "createAccountRoleInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the role label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue."}, "label": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["color", "label"]}, "updateAccountRoleInput": {"properties": {"color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the role label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue."}, "label": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchAccountRoleInput": {"properties": {"color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the role label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue."}, "label": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "AccountSharingClientRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account": {"type": "string", "format": "uri", "description": "Account being shared.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "client": {"type": "string", "format": "uri", "description": "User the account is shared with.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared account."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the account.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "account", "client", "account_id", "client_id"]}, "createAccountSharingClientRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared account."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the account.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["account_id", "client_id"]}, "updateAccountSharingClientRelationInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared account."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the account.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchAccountSharingClientRelationInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared account."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the account.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "AccountSharingSalesUnitRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account": {"type": "string", "format": "uri", "description": "Account being shared.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit the account is shared with.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared account."}, "role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the account.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "account", "unit", "account_id", "unit_id"]}, "createAccountSharingSalesUnitRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared account."}, "role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the account.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["account_id", "unit_id"]}, "updateAccountSharingSalesUnitRelationInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared account."}, "role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the account.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchAccountSharingSalesUnitRelationInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared account."}, "role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the account.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "AccountSocialRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity. Must match with Account id.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "angellist_url": {"type": "string", "example": "string", "description": "AngelList profile URL of the account."}, "crunchbase_url": {"type": "string", "example": "string", "description": "Crunchbase profile URL of the account."}, "disqus_url": {"type": "string", "example": "string", "description": "Disqus profile URL of the account."}, "facebook_id": {"type": "string", "example": "string", "description": "Facebook page or profile id of the account."}, "facebook_url": {"type": "string", "example": "string", "description": "Facebook profile URL of the account."}, "flickr_url": {"type": "string", "example": "string", "description": "Flickr profile URL of the account."}, "foursquare_url": {"type": "string", "example": "string", "description": "Foursquare profile URL of the account."}, "google_id": {"type": "string", "example": "string", "description": "Google business or profile id of the account."}, "google_plus_url": {"type": "string", "example": "string", "description": "Google+ profile URL of the account."}, "gravatar_url": {"type": "string", "example": "string", "description": "Gravatar profile URL of the account."}, "klout_url": {"type": "string", "example": "string", "description": "Klout profile URL of the account."}, "linkedin_id": {"type": "string", "example": "string", "description": "LinkedIn company or profile id of the account."}, "linkedin_url": {"type": "string", "example": "string", "description": "LinkedIn profile URL of the account."}, "pinterest_url": {"type": "string", "example": "string", "description": "Pinterest profile URL of the account."}, "quora_url": {"type": "string", "example": "string", "description": "Quora profile URL of the account."}, "reddit_url": {"type": "string", "example": "string", "description": "Reddit profile URL of the account."}, "skype_url": {"type": "string", "example": "string", "description": "Skype contact URL or username of the account."}, "slideshare_url": {"type": "string", "example": "string", "description": "SlideShare profile URL of the account."}, "twitter_id": {"type": "string", "example": "string", "description": "Twitter (X) user id of the account."}, "twitter_url": {"type": "string", "example": "string", "description": "Twitter (X) profile URL of the account."}, "vimeo_url": {"type": "string", "example": "string", "description": "Vimeo profile URL of the account."}, "wordpress_url": {"type": "string", "example": "string", "description": "WordPress site URL of the account."}, "xing_url": {"type": "string", "example": "string", "description": "XING profile URL of the account."}, "yahoo_url": {"type": "string", "example": "string", "description": "Yahoo profile URL of the account."}, "yelp_url": {"type": "string", "example": "string", "description": "Yelp business URL of the account."}, "youtube_url": {"type": "string", "example": "string", "description": "YouTube channel URL of the account."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id"]}, "createAccountSocialRelationInput": {"properties": {"id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity. Must match with Account id.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "angellist_url": {"type": "string", "example": "string", "description": "AngelList profile URL of the account."}, "crunchbase_url": {"type": "string", "example": "string", "description": "Crunchbase profile URL of the account."}, "disqus_url": {"type": "string", "example": "string", "description": "Disqus profile URL of the account."}, "facebook_id": {"type": "string", "example": "string", "description": "Facebook page or profile id of the account."}, "facebook_url": {"type": "string", "example": "string", "description": "Facebook profile URL of the account."}, "flickr_url": {"type": "string", "example": "string", "description": "Flickr profile URL of the account."}, "foursquare_url": {"type": "string", "example": "string", "description": "Foursquare profile URL of the account."}, "google_id": {"type": "string", "example": "string", "description": "Google business or profile id of the account."}, "google_plus_url": {"type": "string", "example": "string", "description": "Google+ profile URL of the account."}, "gravatar_url": {"type": "string", "example": "string", "description": "Gravatar profile URL of the account."}, "klout_url": {"type": "string", "example": "string", "description": "Klout profile URL of the account."}, "linkedin_id": {"type": "string", "example": "string", "description": "LinkedIn company or profile id of the account."}, "linkedin_url": {"type": "string", "example": "string", "description": "LinkedIn profile URL of the account."}, "pinterest_url": {"type": "string", "example": "string", "description": "Pinterest profile URL of the account."}, "quora_url": {"type": "string", "example": "string", "description": "Quora profile URL of the account."}, "reddit_url": {"type": "string", "example": "string", "description": "Reddit profile URL of the account."}, "skype_url": {"type": "string", "example": "string", "description": "Skype contact URL or username of the account."}, "slideshare_url": {"type": "string", "example": "string", "description": "SlideShare profile URL of the account."}, "twitter_id": {"type": "string", "example": "string", "description": "Twitter (X) user id of the account."}, "twitter_url": {"type": "string", "example": "string", "description": "Twitter (X) profile URL of the account."}, "vimeo_url": {"type": "string", "example": "string", "description": "Vimeo profile URL of the account."}, "wordpress_url": {"type": "string", "example": "string", "description": "WordPress site URL of the account."}, "xing_url": {"type": "string", "example": "string", "description": "XING profile URL of the account."}, "yahoo_url": {"type": "string", "example": "string", "description": "Yahoo profile URL of the account."}, "yelp_url": {"type": "string", "example": "string", "description": "Yelp business URL of the account."}, "youtube_url": {"type": "string", "example": "string", "description": "YouTube channel URL of the account."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["id"]}, "updateAccountSocialRelationInput": {"properties": {"angellist_url": {"type": "string", "example": "string", "description": "AngelList profile URL of the account."}, "crunchbase_url": {"type": "string", "example": "string", "description": "Crunchbase profile URL of the account."}, "disqus_url": {"type": "string", "example": "string", "description": "Disqus profile URL of the account."}, "facebook_id": {"type": "string", "example": "string", "description": "Facebook page or profile id of the account."}, "facebook_url": {"type": "string", "example": "string", "description": "Facebook profile URL of the account."}, "flickr_url": {"type": "string", "example": "string", "description": "Flickr profile URL of the account."}, "foursquare_url": {"type": "string", "example": "string", "description": "Foursquare profile URL of the account."}, "google_id": {"type": "string", "example": "string", "description": "Google business or profile id of the account."}, "google_plus_url": {"type": "string", "example": "string", "description": "Google+ profile URL of the account."}, "gravatar_url": {"type": "string", "example": "string", "description": "Gravatar profile URL of the account."}, "klout_url": {"type": "string", "example": "string", "description": "Klout profile URL of the account."}, "linkedin_id": {"type": "string", "example": "string", "description": "LinkedIn company or profile id of the account."}, "linkedin_url": {"type": "string", "example": "string", "description": "LinkedIn profile URL of the account."}, "pinterest_url": {"type": "string", "example": "string", "description": "Pinterest profile URL of the account."}, "quora_url": {"type": "string", "example": "string", "description": "Quora profile URL of the account."}, "reddit_url": {"type": "string", "example": "string", "description": "Reddit profile URL of the account."}, "skype_url": {"type": "string", "example": "string", "description": "Skype contact URL or username of the account."}, "slideshare_url": {"type": "string", "example": "string", "description": "SlideShare profile URL of the account."}, "twitter_id": {"type": "string", "example": "string", "description": "Twitter (X) user id of the account."}, "twitter_url": {"type": "string", "example": "string", "description": "Twitter (X) profile URL of the account."}, "vimeo_url": {"type": "string", "example": "string", "description": "Vimeo profile URL of the account."}, "wordpress_url": {"type": "string", "example": "string", "description": "WordPress site URL of the account."}, "xing_url": {"type": "string", "example": "string", "description": "XING profile URL of the account."}, "yahoo_url": {"type": "string", "example": "string", "description": "Yahoo profile URL of the account."}, "yelp_url": {"type": "string", "example": "string", "description": "Yelp business URL of the account."}, "youtube_url": {"type": "string", "example": "string", "description": "YouTube channel URL of the account."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchAccountSocialRelationInput": {"properties": {"angellist_url": {"type": "string", "example": "string", "description": "AngelList profile URL of the account."}, "crunchbase_url": {"type": "string", "example": "string", "description": "Crunchbase profile URL of the account."}, "disqus_url": {"type": "string", "example": "string", "description": "Disqus profile URL of the account."}, "facebook_id": {"type": "string", "example": "string", "description": "Facebook page or profile id of the account."}, "facebook_url": {"type": "string", "example": "string", "description": "Facebook profile URL of the account."}, "flickr_url": {"type": "string", "example": "string", "description": "Flickr profile URL of the account."}, "foursquare_url": {"type": "string", "example": "string", "description": "Foursquare profile URL of the account."}, "google_id": {"type": "string", "example": "string", "description": "Google business or profile id of the account."}, "google_plus_url": {"type": "string", "example": "string", "description": "Google+ profile URL of the account."}, "gravatar_url": {"type": "string", "example": "string", "description": "Gravatar profile URL of the account."}, "klout_url": {"type": "string", "example": "string", "description": "Klout profile URL of the account."}, "linkedin_id": {"type": "string", "example": "string", "description": "LinkedIn company or profile id of the account."}, "linkedin_url": {"type": "string", "example": "string", "description": "LinkedIn profile URL of the account."}, "pinterest_url": {"type": "string", "example": "string", "description": "Pinterest profile URL of the account."}, "quora_url": {"type": "string", "example": "string", "description": "Quora profile URL of the account."}, "reddit_url": {"type": "string", "example": "string", "description": "Reddit profile URL of the account."}, "skype_url": {"type": "string", "example": "string", "description": "Skype contact URL or username of the account."}, "slideshare_url": {"type": "string", "example": "string", "description": "SlideShare profile URL of the account."}, "twitter_id": {"type": "string", "example": "string", "description": "Twitter (X) user id of the account."}, "twitter_url": {"type": "string", "example": "string", "description": "Twitter (X) profile URL of the account."}, "vimeo_url": {"type": "string", "example": "string", "description": "Vimeo profile URL of the account."}, "wordpress_url": {"type": "string", "example": "string", "description": "WordPress site URL of the account."}, "xing_url": {"type": "string", "example": "string", "description": "XING profile URL of the account."}, "yahoo_url": {"type": "string", "example": "string", "description": "Yahoo profile URL of the account."}, "yelp_url": {"type": "string", "example": "string", "description": "Yelp business URL of the account."}, "youtube_url": {"type": "string", "example": "string", "description": "YouTube channel URL of the account."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "AccountType": {"properties": {"has_draft": {"type": "boolean", "example": false, "description": "Set to True if draft for entity exists and can be published"}, "is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "form_edit_api": {"type": "object", "description": "API-friendly form definition. Returns the published form merged with any pending draft changes; read via this field, modify via the underlying form_edit / form_lost field through drafts."}, "can_change_readonly": {"type": "boolean", "example": false, "description": "Returns if user can change readonly flag on this entity_type."}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "form_edit": {"type": "object", "description": "JSON definition of the edit form layout used by the UI when creating or editing accounts of this type. Contains tabs, sections, and field placement."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the account type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "is_published": {"type": "boolean", "example": false, "description": "True when the entity configuration is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["has_draft", "is_delete_protected", "form_edit_api", "id", "is_readonly", "name", "settings"]}, "createAccountTypeInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "form_edit": {"type": "object", "description": "JSON definition of the edit form layout used by the UI when creating or editing accounts of this type. Contains tabs, sections, and field placement."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the account type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "is_published": {"type": "boolean", "example": false, "description": "True when the entity configuration is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_readonly", "name", "settings"]}, "updateAccountTypeInput": {"properties": {"form_edit": {"type": "object", "description": "JSON definition of the edit form layout used by the UI when creating or editing accounts of this type. Contains tabs, sections, and field placement."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the account type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchAccountTypeInput": {"properties": {"form_edit": {"type": "object", "description": "JSON definition of the edit form layout used by the UI when creating or editing accounts of this type. Contains tabs, sections, and field placement."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the account type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Activity": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "active_reminder": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the next pending reminder configured for the activity (reminder time, due date or end date as applicable). Empty when no reminder is pending."}, "media_transcription_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked Media record holding the activity's call recording / transcription, when available."}}, "required": ["is_delete_protected", "id"]}, "ActivityComment": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "appointment": {"type": "string", "format": "uri", "description": "Appointment this comment belongs to. Set when activity_id resolves to an Appointment; otherwise empty.\n\nRelation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties."}, "task": {"type": "string", "format": "uri", "description": "Task this comment belongs to. Set when activity_id resolves to a Task; otherwise empty.\n\nRelation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "User who authored the comment.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment or task the comment belongs to."}, "comment": {"type": "string", "example": "string", "description": "Free-form text body of the comment."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the comment author."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "owner", "activity_id", "comment", "owner_id"]}, "createActivityCommentInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment or task the comment belongs to."}, "comment": {"type": "string", "example": "string", "description": "Free-form text body of the comment."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the comment author."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["activity_id", "comment", "owner_id"]}, "updateActivityCommentInput": {"properties": {"activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment or task the comment belongs to."}, "comment": {"type": "string", "example": "string", "description": "Free-form text body of the comment."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the comment author."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchActivityCommentInput": {"properties": {"activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment or task the comment belongs to."}, "comment": {"type": "string", "example": "string", "description": "Free-form text body of the comment."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the comment author."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ActivityDataExRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "appointment": {"type": "string", "format": "uri", "description": "Appointment this enrichment record applies to. Set when activity_id resolves to an Appointment; otherwise empty.\n\nRelation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties."}, "task": {"type": "string", "format": "uri", "description": "Task this enrichment record applies to. Set when activity_id resolves to a Task; otherwise empty.\n\nRelation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties."}, "data": {"type": "string", "format": "uri", "description": "External data record (Data entity) holding the enrichment payload.\n\nRelation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties."}, "activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment or task the enrichment record applies to."}, "data_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the external data record."}, "data_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier of the data set the enrichment record originates from."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "data", "activity_id", "data_id", "data_set_id"]}, "ActivityKPI": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "appointment": {"type": "string", "format": "uri", "description": "Appointment this KPI event relates to. Set when activity_id resolves to an Appointment; otherwise empty.\n\nRelation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties."}, "task": {"type": "string", "format": "uri", "description": "Task this KPI event relates to. Set when activity_id resolves to a Task; otherwise empty.\n\nRelation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties."}, "client": {"type": "string", "format": "uri", "description": "User who triggered the KPI event (e.g. created or completed the activity).\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "Activity owner at the time the KPI event occurred.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit the triggering user belonged to at the time of the event.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment or task the KPI event relates to."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration)."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who triggered the event."}, "kpi": {"type": "integer", "description": "KPI metric this event represents: ActivityCreate, ActivityCompleted.\n\nInteger enum value: 1 - ActivityCreate, 2 - ActivityCompleted", "example": 1, "enum": [1, 2]}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the activity owner at the time of the event."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "unit", "activity_id", "kpi", "unit_id"]}, "createActivityKPIInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment or task the KPI event relates to."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration)."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who triggered the event."}, "kpi": {"type": "integer", "description": "KPI metric this event represents: ActivityCreate, ActivityCompleted.\n\nInteger enum value: 1 - ActivityCreate, 2 - ActivityCompleted", "example": 1, "enum": [1, 2]}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the activity owner at the time of the event."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["activity_id", "kpi", "unit_id"]}, "updateActivityKPIInput": {"properties": {"activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment or task the KPI event relates to."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration)."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who triggered the event."}, "kpi": {"type": "integer", "description": "KPI metric this event represents: ActivityCreate, ActivityCompleted.\n\nInteger enum value: 1 - ActivityCreate, 2 - ActivityCompleted", "example": 1, "enum": [1, 2]}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the activity owner at the time of the event."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchActivityKPIInput": {"properties": {"activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment or task the KPI event relates to."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration)."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who triggered the event."}, "kpi": {"type": "integer", "description": "KPI metric this event represents: ActivityCreate, ActivityCompleted.\n\nInteger enum value: 1 - ActivityCreate, 2 - ActivityCompleted", "example": 1, "enum": [1, 2]}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the activity owner at the time of the event."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ActivityRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account": {"type": "string", "format": "uri", "description": "Account the activity is linked to, or empty when not linked to an account.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "appointment": {"type": "string", "format": "uri", "description": "Appointment side of the link. Set when activity_id resolves to an Appointment; otherwise empty.\n\nRelation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties."}, "task": {"type": "string", "format": "uri", "description": "Task side of the link. Set when activity_id resolves to a Task; otherwise empty.\n\nRelation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties."}, "contact": {"type": "string", "format": "uri", "description": "Contact the activity is linked to, or empty when not linked to a contact.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "custom_entity": {"type": "string", "format": "uri", "description": "Custom entity record the activity is linked to, or empty.\n\nRelation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties."}, "lead": {"type": "string", "format": "uri", "description": "Lead the activity is linked to. Set when lead_oppty_id resolves to a Lead; otherwise empty.\n\nRelation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties."}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity the activity is linked to. Set when lead_oppty_id resolves to an Opportunity; otherwise empty.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "project": {"type": "string", "format": "uri", "description": "Project the activity is linked to, or empty when not linked to a project.\n\nRelation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties."}, "project_objective": {"type": "string", "format": "uri", "description": "Project objective the activity advances, or empty.\n\nRelation to ProjectObjective. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProjectObjective' object for properties."}, "quote": {"type": "string", "format": "uri", "description": "Quote the activity is linked to, or empty when not linked to a quote.\n\nRelation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment or task on this link."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity the activity is linked to, or empty when not linked."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project."}, "project_objective_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project objective."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Display order of the activity within its project objective. Required only when project_id is set."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "activity_id"]}, "createActivityRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "project_objective": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Project objective the activity advances, or empty.\n\nRelation to ProjectObjective, see: 'createProjectObjectiveInput' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment or task on this link."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity the activity is linked to, or empty when not linked."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project."}, "project_objective_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project objective."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Display order of the activity within its project objective. Required only when project_id is set."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["activity_id"]}, "updateActivityRelationInput": {"properties": {"project_objective": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Project objective the activity advances, or empty.\n\nRelation to ProjectObjective, see: 'updateProjectObjectiveInput' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment or task on this link."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity the activity is linked to, or empty when not linked."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project."}, "project_objective_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project objective."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Display order of the activity within its project objective. Required only when project_id is set."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchActivityRelationInput": {"properties": {"project_objective": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Project objective the activity advances, or empty.\n\nRelation to ProjectObjective, see: 'updateProjectObjectiveInput' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment or task on this link."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity the activity is linked to, or empty when not linked."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project."}, "project_objective_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project objective."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Display order of the activity within its project objective. Required only when project_id is set."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "AllowedAccountType": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_type": {"type": "string", "format": "uri", "description": "Account type the user role can use.\n\nRelation to AccountType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountType' object for properties."}, "master_right": {"type": "string", "format": "uri", "description": "User role granted access to the account type.\n\nRelation to MasterRight. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MasterRight' object for properties."}, "account_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account type."}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "account_type", "master_right", "account_type_id", "master_right_id"]}, "createAllowedAccountTypeInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account type."}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["account_type_id", "master_right_id"]}, "updateAllowedAccountTypeInput": {"properties": {"account_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account type."}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchAllowedAccountTypeInput": {"properties": {"account_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account type."}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "AllowedCompanyEmail": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "company_email": {"type": "string", "format": "uri", "description": "Company email address the user role can send from.\n\nRelation to CompanyEmail. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CompanyEmail' object for properties."}, "master_right": {"type": "string", "format": "uri", "description": "User role granted access to the company email address.\n\nRelation to MasterRight. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MasterRight' object for properties."}, "company_email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the company email address."}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "company_email", "master_right", "company_email_id", "master_right_id"]}, "createAllowedCompanyEmailInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "company_email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the company email address."}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["company_email_id", "master_right_id"]}, "updateAllowedCompanyEmailInput": {"properties": {"company_email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the company email address."}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchAllowedCompanyEmailInput": {"properties": {"company_email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the company email address."}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "AllowedCompanyPhone": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "master_right": {"type": "string", "format": "uri", "description": "User role granted access to the company phone.\n\nRelation to MasterRight. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MasterRight' object for properties."}, "phone": {"type": "string", "format": "uri", "description": "Company phone the user role can use for calling/SMS.\n\nRelation to Phone. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Phone' object for properties."}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "phone_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the company phone."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "master_right", "phone", "master_right_id", "phone_id"]}, "createAllowedCompanyPhoneInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "phone_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the company phone."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["master_right_id", "phone_id"]}, "updateAllowedCompanyPhoneInput": {"properties": {"master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "phone_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the company phone."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchAllowedCompanyPhoneInput": {"properties": {"master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "phone_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the company phone."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "AllowedContactType": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "contact_type": {"type": "string", "format": "uri", "description": "Contact type the user role can use.\n\nRelation to ContactType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactType' object for properties."}, "master_right": {"type": "string", "format": "uri", "description": "User role granted access to the contact type.\n\nRelation to MasterRight. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MasterRight' object for properties."}, "contact_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact type."}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "contact_type", "master_right", "contact_type_id", "master_right_id"]}, "createAllowedContactTypeInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "contact_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact type."}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["contact_type_id", "master_right_id"]}, "updateAllowedContactTypeInput": {"properties": {"contact_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact type."}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchAllowedContactTypeInput": {"properties": {"contact_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact type."}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "AllowedLeadType": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "lead_type": {"type": "string", "format": "uri", "description": "Lead type the user role can use.\n\nRelation to LeadType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadType' object for properties."}, "master_right": {"type": "string", "format": "uri", "description": "User role granted access to the lead type.\n\nRelation to MasterRight. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MasterRight' object for properties."}, "lead_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead type."}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "lead_type", "master_right", "lead_type_id", "master_right_id"]}, "createAllowedLeadTypeInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "lead_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead type."}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["lead_type_id", "master_right_id"]}, "updateAllowedLeadTypeInput": {"properties": {"lead_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead type."}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchAllowedLeadTypeInput": {"properties": {"lead_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead type."}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "AllowedPipeline": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "master_right": {"type": "string", "format": "uri", "description": "User role granted access to the pipeline.\n\nRelation to MasterRight. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MasterRight' object for properties."}, "pipeline": {"type": "string", "format": "uri", "description": "Pipeline the user role can use.\n\nRelation to Pipeline. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Pipeline' object for properties."}, "access_step_documents": {"type": "boolean", "example": false, "description": "When true, the user role can access documents attached to steps of this pipeline."}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "pipeline_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the pipeline."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "master_right", "pipeline", "master_right_id", "pipeline_id"]}, "createAllowedPipelineInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "access_step_documents": {"type": "boolean", "example": false, "description": "When true, the user role can access documents attached to steps of this pipeline."}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "pipeline_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the pipeline."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["master_right_id", "pipeline_id"]}, "updateAllowedPipelineInput": {"properties": {"access_step_documents": {"type": "boolean", "example": false, "description": "When true, the user role can access documents attached to steps of this pipeline."}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "pipeline_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the pipeline."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchAllowedPipelineInput": {"properties": {"access_step_documents": {"type": "boolean", "example": false, "description": "When true, the user role can access documents attached to steps of this pipeline."}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "pipeline_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the pipeline."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "AllowedQuoteType": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "master_right": {"type": "string", "format": "uri", "description": "User role granted access to the quote type.\n\nRelation to MasterRight. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MasterRight' object for properties."}, "quote_type": {"type": "string", "format": "uri", "description": "Quote type the user role can use.\n\nRelation to QuoteType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'QuoteType' object for properties."}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "quote_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "master_right", "quote_type", "master_right_id", "quote_type_id"]}, "createAllowedQuoteTypeInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "quote_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["master_right_id", "quote_type_id"]}, "updateAllowedQuoteTypeInput": {"properties": {"master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "quote_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchAllowedQuoteTypeInput": {"properties": {"master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "quote_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ApiAccess": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity. Must match with Application id.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "email": {"type": "string", "example": "string", "description": "Contact email associated with this API access. Used for credential change notifications."}, "is_active": {"type": "boolean", "example": false, "description": "Whether this API access can authenticate. Set to false to disable the credentials without deleting the record; existing tokens stop working immediately."}, "last_used": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent successful authentication using this API access. Updated automatically on each use; empty for credentials that have never been used."}, "permissions": {"type": "object", "description": "Per-section access permissions (records, administration, misc) granted to this API access. Determines which entities and operations the credentials can read or write."}, "type": {"type": "integer", "description": "Authentication type of this API access (e.g. standard API key vs. OAuth client). Set automatically on create and cannot be changed.\n\nInteger enum value: 1 - Basic, 2 - OAuth", "example": 1, "enum": [1, 2], "readOnly": true}, "name": {"type": "string", "example": "string", "description": "Name for the api access."}, "username": {"type": "string", "example": "string", "description": "Username portion of the API credentials issued for this access."}, "plain_password": {"type": "string", "example": "string", "description": "Plain-text password issued for this API access. Returned only at create time and for migrated legacy access; otherwise empty. Integrators must store it on receipt \u2014 it is not retrievable later."}}, "required": ["is_delete_protected", "id", "type", "name"]}, "Appointment": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "active_reminder": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the next pending reminder configured for the activity (reminder time, due date or end date as applicable). Empty when no reminder is pending."}, "media_transcription_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked Media record holding the activity's call recording / transcription, when available."}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "activity_type": {"type": "string", "format": "uri", "description": "Appointment type that classifies this appointment. Drives form layout and icon.\n\nRelation to AppointmentType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentType' object for properties."}, "currency_exchange_rates_list": {"type": "string", "format": "uri", "description": "Currency exchange rate list used to convert monetary fields linked to this appointment. Empty to inherit the team space default.\n\nRelation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRatesList' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "Sales user who owns this appointment.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "recurrence_master": {"type": "string", "format": "uri", "description": "Master appointment of the recurring series this occurrence belongs to. Empty for standalone appointments and for the master itself.\n\nRelation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties."}, "schedule": {"type": "string", "format": "uri", "description": "Appointment schedule (booking link) this appointment was created through, or empty for appointments created directly.\n\nRelation to AppointmentSchedule. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentSchedule' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit this appointment is assigned to. Determines which team members can see the record under unit-based sharing.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "activity_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment type."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this appointment."}, "description": {"type": "string", "example": "string", "description": "Free-form description of the appointment."}, "duration": {"type": "number", "format": "double", "example": "4.32", "description": "Duration of the appointment, derived from start/end dates."}, "end_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "End timestamp of the appointment."}, "invitees_can_edit": {"type": "boolean", "example": false, "description": "True when invitees are allowed to edit the appointment. Defaults to false."}, "is_recurrence_active": {"type": "boolean", "example": false, "description": "True when the recurrence series is still generating new occurrences. Read-only."}, "is_recurrence_exception": {"type": "boolean", "example": false, "description": "True when this occurrence has been modified independently of the recurring series. Read-only."}, "location": {"type": "string", "example": "string", "description": "Free-text physical location of the appointment."}, "meeting_url": {"type": "object", "description": "Online meeting link associated with the appointment (join URL plus meeting type, e.g. Zoom, Teams). Empty when the appointment has no online meeting attached."}, "occurence_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Original date of this occurrence in the recurring series. Set automatically."}, "organizer": {"type": "string", "example": "string", "description": "Email of the user organising the appointment. Set automatically and used as the reply-to address in invitation emails."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment owner."}, "recurrence_master_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the master appointment."}, "recurrence_rule": {"type": "string", "example": "string", "description": "iCalendar RRULE string describing the recurrence pattern (e.g. \"FREQ=WEEKLY;BYDAY=MO,WE\"). Empty for non-recurring appointments."}, "recurrence_tzid": {"type": "string", "example": "string", "description": "IANA timezone the recurrence rule is evaluated in."}, "schedule_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment schedule."}, "schedule_tzid": {"type": "string", "example": "string", "description": "IANA timezone the appointment was booked in (e.g. \"Europe/Bratislava\"). Used to evaluate availability against the schedule."}, "start_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Start timestamp of the appointment."}, "subject": {"type": "string", "example": "string", "description": "Short summary line shown in calendars and lists."}, "table_name": {"type": "string", "example": "string", "description": "Discriminator identifying the concrete record type \u2014 always \"appointment\" for Appointment records. Read-only; useful when consuming polymorphic Activity results.", "readOnly": true}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "status": {"type": "integer", "description": "Current status of the appointment (NotStarted, InProgress, Completed, Canceled). Read-only; derived from the start/end times and the deleted flag.\n\nInteger enum value: 1 - NotStarted, 2 - InProgress, 3 - Waiting, 4 - Completed, 5 - Deferred, 6 - Canceled", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "account_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties."}, "description": "Accounts this appointment is linked to."}, "contact_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties."}, "description": "Contacts this appointment is linked to."}, "lead_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties."}, "description": "Leads this appointment is linked to."}, "opportunity_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties."}, "description": "Opportunities this appointment is linked to."}, "project_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties."}, "description": "Projects this appointment is linked to, including the per-objective ordering."}, "quote_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties."}, "description": "Quotes this appointment is linked to."}, "custom_entity_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties."}, "description": "Custom entity records this appointment is linked to."}, "invitees_contacts": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to AppointmentContactInviteesRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentContactInviteesRelation' object for properties."}, "description": "Non-user invitees on this appointment, identified by email. Contacts are auto-linked when their email matches an existing Contact record."}, "invitees_clients": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to AppointmentClientInviteesRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentClientInviteesRelation' object for properties."}, "description": "Internal-user invitees on this appointment."}, "exchange_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "gapi_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "o365_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "has_3rd_party_mapping": {"type": "boolean", "example": false, "description": "True when this appointment is mirrored to an external calendar (Office 365, Exchange, Google). Read-only."}, "reminder": {"type": "string", "format": "uri", "description": "Reminder set by the current authenticated user for this appointment. Per-user; empty when no reminder has been set.\n\nRelation to AppointmentReminder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentReminder' object for properties."}, "documents": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties."}, "description": "Documents linked to this appointment."}, "comments": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ActivityComment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityComment' object for properties."}, "description": "Comments authored on this appointment."}, "tags": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to TagRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TagRelation' object for properties."}, "description": "Tag labels applied to this appointment."}, "formatted_name": {"type": "string", "example": "string", "description": "Display name of the appointment (alias of subject)."}, "recurrence": {"type": "object", "description": "Recurrence configuration for recurring appointments (parsed RRULE plus exception metadata). Empty for one-off appointments."}, "modified_by_user": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera."}}, "required": ["is_delete_protected", "id", "activity_type", "owner", "unit", "end_date", "owner_id", "subject", "table_name", "status", "has_3rd_party_mapping", "formatted_name"]}, "createAppointmentInput": {"properties": {"media_transcription_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked Media record holding the activity's call recording / transcription, when available."}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "activity_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment type."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this appointment."}, "description": {"type": "string", "example": "string", "description": "Free-form description of the appointment."}, "duration": {"type": "number", "format": "double", "example": "4.32", "description": "Duration of the appointment, derived from start/end dates."}, "end_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "End timestamp of the appointment."}, "invitees_can_edit": {"type": "boolean", "example": false, "description": "True when invitees are allowed to edit the appointment. Defaults to false."}, "is_recurrence_active": {"type": "boolean", "example": false, "description": "True when the recurrence series is still generating new occurrences. Read-only."}, "is_recurrence_exception": {"type": "boolean", "example": false, "description": "True when this occurrence has been modified independently of the recurring series. Read-only."}, "location": {"type": "string", "example": "string", "description": "Free-text physical location of the appointment."}, "meeting_url": {"type": "object", "description": "Online meeting link associated with the appointment (join URL plus meeting type, e.g. Zoom, Teams). Empty when the appointment has no online meeting attached."}, "occurence_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Original date of this occurrence in the recurring series. Set automatically."}, "organizer": {"type": "string", "example": "string", "description": "Email of the user organising the appointment. Set automatically and used as the reply-to address in invitation emails."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment owner."}, "recurrence_master_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the master appointment."}, "recurrence_rule": {"type": "string", "example": "string", "description": "iCalendar RRULE string describing the recurrence pattern (e.g. \"FREQ=WEEKLY;BYDAY=MO,WE\"). Empty for non-recurring appointments."}, "recurrence_tzid": {"type": "string", "example": "string", "description": "IANA timezone the recurrence rule is evaluated in."}, "schedule_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment schedule."}, "schedule_tzid": {"type": "string", "example": "string", "description": "IANA timezone the appointment was booked in (e.g. \"Europe/Bratislava\"). Used to evaluate availability against the schedule."}, "start_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Start timestamp of the appointment."}, "subject": {"type": "string", "example": "string", "description": "Short summary line shown in calendars and lists."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties."}, "description": "Accounts this appointment is linked to."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties."}, "description": "Contacts this appointment is linked to."}, "lead_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties."}, "description": "Leads this appointment is linked to."}, "opportunity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties."}, "description": "Opportunities this appointment is linked to."}, "project_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties."}, "description": "Projects this appointment is linked to, including the per-objective ordering."}, "quote_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties."}, "description": "Quotes this appointment is linked to."}, "custom_entity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties."}, "description": "Custom entity records this appointment is linked to."}, "invitees_contacts": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AppointmentContactInviteesRelation, see: 'createAppointmentContactInviteesRelationInput' object for properties."}, "description": "Non-user invitees on this appointment, identified by email. Contacts are auto-linked when their email matches an existing Contact record."}, "invitees_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AppointmentClientInviteesRelation, see: 'createAppointmentClientInviteesRelationInput' object for properties."}, "description": "Internal-user invitees on this appointment."}, "reminder": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Reminder set by the current authenticated user for this appointment. Per-user; empty when no reminder has been set.\n\nRelation to AppointmentReminder, see: 'createAppointmentReminderInput' object for properties."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this appointment."}, "comments": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityComment, see: 'createActivityCommentInput' object for properties."}, "description": "Comments authored on this appointment."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'createTagRelationInput' object for properties."}, "description": "Tag labels applied to this appointment."}}, "required": ["end_date", "owner_id", "subject"]}, "updateAppointmentInput": {"properties": {"media_transcription_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked Media record holding the activity's call recording / transcription, when available."}, "activity_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment type."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this appointment."}, "description": {"type": "string", "example": "string", "description": "Free-form description of the appointment."}, "duration": {"type": "number", "format": "double", "example": "4.32", "description": "Duration of the appointment, derived from start/end dates."}, "end_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "End timestamp of the appointment."}, "invitees_can_edit": {"type": "boolean", "example": false, "description": "True when invitees are allowed to edit the appointment. Defaults to false."}, "is_recurrence_active": {"type": "boolean", "example": false, "description": "True when the recurrence series is still generating new occurrences. Read-only."}, "is_recurrence_exception": {"type": "boolean", "example": false, "description": "True when this occurrence has been modified independently of the recurring series. Read-only."}, "location": {"type": "string", "example": "string", "description": "Free-text physical location of the appointment."}, "meeting_url": {"type": "object", "description": "Online meeting link associated with the appointment (join URL plus meeting type, e.g. Zoom, Teams). Empty when the appointment has no online meeting attached."}, "occurence_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Original date of this occurrence in the recurring series. Set automatically."}, "organizer": {"type": "string", "example": "string", "description": "Email of the user organising the appointment. Set automatically and used as the reply-to address in invitation emails."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment owner."}, "recurrence_master_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the master appointment."}, "recurrence_rule": {"type": "string", "example": "string", "description": "iCalendar RRULE string describing the recurrence pattern (e.g. \"FREQ=WEEKLY;BYDAY=MO,WE\"). Empty for non-recurring appointments."}, "recurrence_tzid": {"type": "string", "example": "string", "description": "IANA timezone the recurrence rule is evaluated in."}, "schedule_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment schedule."}, "schedule_tzid": {"type": "string", "example": "string", "description": "IANA timezone the appointment was booked in (e.g. \"Europe/Bratislava\"). Used to evaluate availability against the schedule."}, "start_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Start timestamp of the appointment."}, "subject": {"type": "string", "example": "string", "description": "Short summary line shown in calendars and lists."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Accounts this appointment is linked to."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Contacts this appointment is linked to."}, "lead_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Leads this appointment is linked to."}, "opportunity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Opportunities this appointment is linked to."}, "project_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Projects this appointment is linked to, including the per-objective ordering."}, "quote_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Quotes this appointment is linked to."}, "custom_entity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Custom entity records this appointment is linked to."}, "invitees_contacts": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AppointmentContactInviteesRelation, see: 'updateAppointmentContactInviteesRelationInput' object for properties."}, "description": "Non-user invitees on this appointment, identified by email. Contacts are auto-linked when their email matches an existing Contact record."}, "invitees_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AppointmentClientInviteesRelation, see: 'updateAppointmentClientInviteesRelationInput' object for properties."}, "description": "Internal-user invitees on this appointment."}, "exchange_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "gapi_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "o365_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this appointment."}, "comments": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityComment, see: 'updateActivityCommentInput' object for properties."}, "description": "Comments authored on this appointment."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'updateTagRelationInput' object for properties."}, "description": "Tag labels applied to this appointment."}}}, "batchAppointmentInput": {"properties": {"media_transcription_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked Media record holding the activity's call recording / transcription, when available."}, "activity_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment type."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this appointment."}, "description": {"type": "string", "example": "string", "description": "Free-form description of the appointment."}, "duration": {"type": "number", "format": "double", "example": "4.32", "description": "Duration of the appointment, derived from start/end dates."}, "end_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "End timestamp of the appointment."}, "invitees_can_edit": {"type": "boolean", "example": false, "description": "True when invitees are allowed to edit the appointment. Defaults to false."}, "is_recurrence_active": {"type": "boolean", "example": false, "description": "True when the recurrence series is still generating new occurrences. Read-only."}, "is_recurrence_exception": {"type": "boolean", "example": false, "description": "True when this occurrence has been modified independently of the recurring series. Read-only."}, "location": {"type": "string", "example": "string", "description": "Free-text physical location of the appointment."}, "meeting_url": {"type": "object", "description": "Online meeting link associated with the appointment (join URL plus meeting type, e.g. Zoom, Teams). Empty when the appointment has no online meeting attached."}, "occurence_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Original date of this occurrence in the recurring series. Set automatically."}, "organizer": {"type": "string", "example": "string", "description": "Email of the user organising the appointment. Set automatically and used as the reply-to address in invitation emails."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment owner."}, "recurrence_master_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the master appointment."}, "recurrence_rule": {"type": "string", "example": "string", "description": "iCalendar RRULE string describing the recurrence pattern (e.g. \"FREQ=WEEKLY;BYDAY=MO,WE\"). Empty for non-recurring appointments."}, "recurrence_tzid": {"type": "string", "example": "string", "description": "IANA timezone the recurrence rule is evaluated in."}, "schedule_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment schedule."}, "schedule_tzid": {"type": "string", "example": "string", "description": "IANA timezone the appointment was booked in (e.g. \"Europe/Bratislava\"). Used to evaluate availability against the schedule."}, "start_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Start timestamp of the appointment."}, "subject": {"type": "string", "example": "string", "description": "Short summary line shown in calendars and lists."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Accounts this appointment is linked to."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Contacts this appointment is linked to."}, "lead_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Leads this appointment is linked to."}, "opportunity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Opportunities this appointment is linked to."}, "project_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Projects this appointment is linked to, including the per-objective ordering."}, "quote_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Quotes this appointment is linked to."}, "custom_entity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Custom entity records this appointment is linked to."}, "invitees_contacts": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AppointmentContactInviteesRelation, see: 'updateAppointmentContactInviteesRelationInput' object for properties."}, "description": "Non-user invitees on this appointment, identified by email. Contacts are auto-linked when their email matches an existing Contact record."}, "invitees_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AppointmentClientInviteesRelation, see: 'updateAppointmentClientInviteesRelationInput' object for properties."}, "description": "Internal-user invitees on this appointment."}, "exchange_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "gapi_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "o365_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this appointment."}, "comments": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityComment, see: 'updateActivityCommentInput' object for properties."}, "description": "Comments authored on this appointment."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'updateTagRelationInput' object for properties."}, "description": "Tag labels applied to this appointment."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "AppointmentClientInviteesRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "appointment": {"type": "string", "format": "uri", "description": "Appointment the user has been invited to.\n\nRelation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties."}, "client": {"type": "string", "format": "uri", "description": "Internal user invited to the appointment.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "appointment_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "response": {"type": "integer", "description": "Invitee response (e.g. Accepted, Tentative, Declined, Pending).\n\nInteger enum value: 0 - NoResponse, 1 - Accepted, 2 - Rejected", "example": 0, "enum": [0, 1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "appointment", "client", "appointment_id", "client_id"]}, "createAppointmentClientInviteesRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "appointment_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "response": {"type": "integer", "description": "Invitee response (e.g. Accepted, Tentative, Declined, Pending).\n\nInteger enum value: 0 - NoResponse, 1 - Accepted, 2 - Rejected", "example": 0, "enum": [0, 1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["appointment_id", "client_id"]}, "updateAppointmentClientInviteesRelationInput": {"properties": {"appointment_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "response": {"type": "integer", "description": "Invitee response (e.g. Accepted, Tentative, Declined, Pending).\n\nInteger enum value: 0 - NoResponse, 1 - Accepted, 2 - Rejected", "example": 0, "enum": [0, 1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchAppointmentClientInviteesRelationInput": {"properties": {"appointment_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "response": {"type": "integer", "description": "Invitee response (e.g. Accepted, Tentative, Declined, Pending).\n\nInteger enum value: 0 - NoResponse, 1 - Accepted, 2 - Rejected", "example": 0, "enum": [0, 1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "AppointmentContactInviteesRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "appointment": {"type": "string", "format": "uri", "description": "Appointment the contact has been invited to.\n\nRelation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties."}, "contact": {"type": "string", "format": "uri", "description": "Coevera Contact record matching the invitee email, when one exists.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "appointment_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the matched contact."}, "email": {"type": "string", "example": "string", "description": "Email address of the invitee. Required and used as the natural key for the link."}, "first_name": {"type": "string", "example": "string", "description": "Given name of the invitee, when supplied."}, "invitee_type": {"type": "integer", "description": "How the invitee was added (e.g. as a contact, free-form email, schedule booking).\n\nInteger enum value: 0 - Standard, 1 - Scheduled", "example": 0, "enum": [0, 1]}, "last_name": {"type": "string", "example": "string", "description": "Family name of the invitee, when supplied."}, "response": {"type": "integer", "description": "Invitee response (e.g. Accepted, Tentative, Declined, Pending).\n\nInteger enum value: 0 - NoResponse, 1 - Accepted, 2 - Rejected", "example": 0, "enum": [0, 1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "appointment", "appointment_id", "email"]}, "createAppointmentContactInviteesRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "appointment_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the matched contact."}, "email": {"type": "string", "example": "string", "description": "Email address of the invitee. Required and used as the natural key for the link."}, "first_name": {"type": "string", "example": "string", "description": "Given name of the invitee, when supplied."}, "invitee_type": {"type": "integer", "description": "How the invitee was added (e.g. as a contact, free-form email, schedule booking).\n\nInteger enum value: 0 - Standard, 1 - Scheduled", "example": 0, "enum": [0, 1]}, "last_name": {"type": "string", "example": "string", "description": "Family name of the invitee, when supplied."}, "response": {"type": "integer", "description": "Invitee response (e.g. Accepted, Tentative, Declined, Pending).\n\nInteger enum value: 0 - NoResponse, 1 - Accepted, 2 - Rejected", "example": 0, "enum": [0, 1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["appointment_id", "email"]}, "updateAppointmentContactInviteesRelationInput": {"properties": {"appointment_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the matched contact."}, "email": {"type": "string", "example": "string", "description": "Email address of the invitee. Required and used as the natural key for the link."}, "first_name": {"type": "string", "example": "string", "description": "Given name of the invitee, when supplied."}, "invitee_type": {"type": "integer", "description": "How the invitee was added (e.g. as a contact, free-form email, schedule booking).\n\nInteger enum value: 0 - Standard, 1 - Scheduled", "example": 0, "enum": [0, 1]}, "last_name": {"type": "string", "example": "string", "description": "Family name of the invitee, when supplied."}, "response": {"type": "integer", "description": "Invitee response (e.g. Accepted, Tentative, Declined, Pending).\n\nInteger enum value: 0 - NoResponse, 1 - Accepted, 2 - Rejected", "example": 0, "enum": [0, 1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchAppointmentContactInviteesRelationInput": {"properties": {"appointment_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the matched contact."}, "email": {"type": "string", "example": "string", "description": "Email address of the invitee. Required and used as the natural key for the link."}, "first_name": {"type": "string", "example": "string", "description": "Given name of the invitee, when supplied."}, "invitee_type": {"type": "integer", "description": "How the invitee was added (e.g. as a contact, free-form email, schedule booking).\n\nInteger enum value: 0 - Standard, 1 - Scheduled", "example": 0, "enum": [0, 1]}, "last_name": {"type": "string", "example": "string", "description": "Family name of the invitee, when supplied."}, "response": {"type": "integer", "description": "Invitee response (e.g. Accepted, Tentative, Declined, Pending).\n\nInteger enum value: 0 - NoResponse, 1 - Accepted, 2 - Rejected", "example": 0, "enum": [0, 1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "AppointmentReminder": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "appointment": {"type": "string", "format": "uri", "description": "Appointment this reminder belongs to.\n\nRelation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "User who set this reminder. Reminders are per-user.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "appointment_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment."}, "end_date_offset": {"type": "integer", "format": "int32", "example": 1, "description": "Minutes before the appointment start when the reminder should fire."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who set the reminder."}, "snooze_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp when a snoozed reminder should fire again. Empty when not snoozed."}, "status": {"type": "integer", "description": "Current state of the reminder (e.g. NotSent, Sent, Snoozed, Dismissed).\n\nInteger enum value: 0 - Snoozed, 1 - Scheduled, 2 - Dismissed", "example": 0, "enum": [0, 1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "appointment", "owner", "appointment_id", "end_date_offset", "owner_id"]}, "createAppointmentReminderInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "appointment_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment."}, "end_date_offset": {"type": "integer", "format": "int32", "example": 1, "description": "Minutes before the appointment start when the reminder should fire."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who set the reminder."}, "snooze_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp when a snoozed reminder should fire again. Empty when not snoozed."}, "status": {"type": "integer", "description": "Current state of the reminder (e.g. NotSent, Sent, Snoozed, Dismissed).\n\nInteger enum value: 0 - Snoozed, 1 - Scheduled, 2 - Dismissed", "example": 0, "enum": [0, 1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["appointment_id", "end_date_offset", "owner_id"]}, "updateAppointmentReminderInput": {"properties": {"appointment_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment."}, "end_date_offset": {"type": "integer", "format": "int32", "example": 1, "description": "Minutes before the appointment start when the reminder should fire."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who set the reminder."}, "snooze_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp when a snoozed reminder should fire again. Empty when not snoozed."}, "status": {"type": "integer", "description": "Current state of the reminder (e.g. NotSent, Sent, Snoozed, Dismissed).\n\nInteger enum value: 0 - Snoozed, 1 - Scheduled, 2 - Dismissed", "example": 0, "enum": [0, 1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchAppointmentReminderInput": {"properties": {"appointment_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment."}, "end_date_offset": {"type": "integer", "format": "int32", "example": 1, "description": "Minutes before the appointment start when the reminder should fire."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who set the reminder."}, "snooze_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp when a snoozed reminder should fire again. Empty when not snoozed."}, "status": {"type": "integer", "description": "Current state of the reminder (e.g. NotSent, Sent, Snoozed, Dismissed).\n\nInteger enum value: 0 - Snoozed, 1 - Scheduled, 2 - Dismissed", "example": 0, "enum": [0, 1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "AppointmentSchedule": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "appointment_owner": {"type": "string", "format": "uri", "description": "User assigned as the appointment owner when a booking is made through this schedule.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "appointment_type": {"type": "string", "format": "uri", "description": "Appointment type used when a booking is created.\n\nRelation to AppointmentType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentType' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "Owner of the schedule (typically the team member whose availability is exposed).\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "reply_company_email": {"type": "string", "format": "uri", "description": "Sender company email used as the From / Reply-To on schedule confirmation emails. Empty falls back to the team space default.\n\nRelation to CompanyEmail. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CompanyEmail' object for properties."}, "appointment_description": {"type": "string", "example": "string", "description": "Description applied to appointments booked through this schedule."}, "appointment_duration": {"type": "number", "format": "double", "example": "4.32", "description": "Duration of each booked appointment."}, "appointment_location": {"type": "string", "example": "string", "description": "Location applied to appointments booked through this schedule."}, "appointment_location_type": {"type": "integer", "description": "How the location is interpreted (e.g. PhysicalAddress, OnlineMeeting).\n\nInteger enum value: 0 - Custom, 1 - Microsoft, 2 - Zoom", "example": 0, "enum": [0, 1, 2]}, "appointment_owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user receiving the booking."}, "appointment_subject": {"type": "string", "example": "string", "description": "Subject applied to appointments booked through this schedule."}, "appointment_subject_uses_schedule_name": {"type": "boolean", "example": false, "description": "When true, booked appointments use the schedule_name as their subject instead of appointment_subject."}, "appointment_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment type."}, "availability_tzid": {"type": "string", "example": "string", "description": "IANA timezone (e.g. \"Europe/Bratislava\") in which availability windows are defined."}, "buffer_time_after": {"type": "integer", "format": "int32", "example": 1, "description": "Minutes of buffer reserved after each booked appointment."}, "buffer_time_before": {"type": "integer", "format": "int32", "example": 1, "description": "Minutes of buffer reserved before each booked appointment."}, "confirmation_page_type": {"type": "integer", "description": "What is shown to the booker after confirming (e.g. default Coevera page or a custom redirect URL).\n\nInteger enum value: 0 - ConfirmationPage, 1 - ExternalUrl", "example": 0, "enum": [0, 1]}, "confirmation_page_url": {"type": "string", "example": "string", "description": "Custom URL the booker is redirected to after confirming. Used when confirmation_page_type selects a custom redirect."}, "is_enabled": {"type": "boolean", "example": false, "description": "Master switch for the schedule. Disabled schedules do not accept new bookings."}, "minimum_notice_time": {"type": "integer", "format": "int32", "example": 1, "description": "Minimum notice in hours required before a slot can be booked."}, "name": {"type": "string", "example": "string", "description": "Admin-only name for the schedule, used in pickers and lists. Not shown to bookers; use schedule_name for the public-facing name."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the schedule owner."}, "planning_day_offset": {"type": "integer", "format": "int32", "example": 1, "description": "For rolling planning: how many days ahead the schedule remains bookable."}, "planning_period_from": {"type": "string", "format": "date", "example": "2019-01-01", "description": "For fixed-range planning: first date bookings are accepted for."}, "planning_period_to": {"type": "string", "format": "date", "example": "2019-01-01", "description": "For fixed-range planning: last date bookings are accepted for."}, "planning_type": {"type": "integer", "description": "How far ahead bookings are accepted (e.g. RollingDays, FixedRange).\n\nInteger enum value: 0 - Infinite, 1 - Offset, 2 - Period", "example": 0, "enum": [0, 1, 2]}, "reminder_email_enabled": {"type": "boolean", "example": false, "description": "True when a reminder email is sent to invitees ahead of the booked appointment."}, "reminder_email_offset": {"type": "integer", "format": "int32", "example": 1, "description": "Time before the appointment when the reminder email is sent. Interpreted using reminder_email_offset_type."}, "reminder_email_offset_type": {"type": "integer", "description": "Unit of reminder_email_offset (e.g. Minutes, Hours, Days).\n\nInteger enum value: 0 - Minute, 1 - Hour, 2 - Day, 3 - Week", "example": 0, "enum": [0, 1, 2, 3]}, "reply_company_email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the reply company email."}, "schedule_name": {"type": "string", "example": "string", "description": "Public-facing name of the schedule, shown to bookers on the booking page."}, "time_increment": {"type": "integer", "format": "int32", "example": 1, "description": "Step in minutes between offered start times (e.g. 15 means slots at :00, :15, :30, :45)."}, "type": {"type": "integer", "description": "Schedule type (e.g. one-on-one or round-robin).\n\nInteger enum value: 0 - OneToOne, 1 - Group", "example": 0, "enum": [0, 1]}, "url": {"type": "string", "example": "string", "description": "Public URL slug of the schedule, used to share the booking page."}, "additional_fields_data": {"type": "array", "items": {"type": "object", "properties": {"field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Field id"}, "label": {"type": "string", "example": "string", "description": "Field label"}, "is_required": {"type": "boolean", "example": false, "description": "Whether value may be null/empty"}}, "required": ["field_id", "label", "is_required"]}, "description": "Custom fields the booker is asked to fill in on the booking page, in display order."}, "availability_data": {"type": "object", "description": "Weekly availability windows (per weekday) used to compute bookable slots, in the schedule's availability_tzid timezone."}, "appointment_invitees_data": {"type": "array", "items": {"type": "object", "properties": {"entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Entity id or null"}, "email": {"type": "string", "example": "string", "description": "Email address"}, "type": {"type": "integer", "description": "Integer enum value: 1 - Client, 2 - Contact, 3 - Email", "example": 1, "enum": [1, 2, 3]}}, "required": ["email", "type"]}, "description": "Default invitees added to appointments booked through this schedule (Pipeliner users or external email addresses)."}}, "required": ["is_delete_protected", "id", "appointment_owner", "appointment_type", "owner", "appointment_description", "appointment_location", "appointment_owner_id", "appointment_subject", "appointment_subject_uses_schedule_name", "appointment_type_id", "buffer_time_after", "buffer_time_before", "is_enabled", "minimum_notice_time", "name", "owner_id", "planning_day_offset", "reminder_email_enabled", "reminder_email_offset", "schedule_name", "time_increment", "url", "additional_fields_data", "availability_data", "appointment_invitees_data"]}, "createAppointmentScheduleInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "appointment_description": {"type": "string", "example": "string", "description": "Description applied to appointments booked through this schedule."}, "appointment_duration": {"type": "number", "format": "double", "example": "4.32", "description": "Duration of each booked appointment."}, "appointment_location": {"type": "string", "example": "string", "description": "Location applied to appointments booked through this schedule."}, "appointment_location_type": {"type": "integer", "description": "How the location is interpreted (e.g. PhysicalAddress, OnlineMeeting).\n\nInteger enum value: 0 - Custom, 1 - Microsoft, 2 - Zoom", "example": 0, "enum": [0, 1, 2]}, "appointment_owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user receiving the booking."}, "appointment_subject": {"type": "string", "example": "string", "description": "Subject applied to appointments booked through this schedule."}, "appointment_subject_uses_schedule_name": {"type": "boolean", "example": false, "description": "When true, booked appointments use the schedule_name as their subject instead of appointment_subject."}, "appointment_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment type."}, "availability_tzid": {"type": "string", "example": "string", "description": "IANA timezone (e.g. \"Europe/Bratislava\") in which availability windows are defined."}, "buffer_time_after": {"type": "integer", "format": "int32", "example": 1, "description": "Minutes of buffer reserved after each booked appointment."}, "buffer_time_before": {"type": "integer", "format": "int32", "example": 1, "description": "Minutes of buffer reserved before each booked appointment."}, "confirmation_page_type": {"type": "integer", "description": "What is shown to the booker after confirming (e.g. default Coevera page or a custom redirect URL).\n\nInteger enum value: 0 - ConfirmationPage, 1 - ExternalUrl", "example": 0, "enum": [0, 1]}, "confirmation_page_url": {"type": "string", "example": "string", "description": "Custom URL the booker is redirected to after confirming. Used when confirmation_page_type selects a custom redirect."}, "is_enabled": {"type": "boolean", "example": false, "description": "Master switch for the schedule. Disabled schedules do not accept new bookings."}, "minimum_notice_time": {"type": "integer", "format": "int32", "example": 1, "description": "Minimum notice in hours required before a slot can be booked."}, "name": {"type": "string", "example": "string", "description": "Admin-only name for the schedule, used in pickers and lists. Not shown to bookers; use schedule_name for the public-facing name."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the schedule owner."}, "planning_day_offset": {"type": "integer", "format": "int32", "example": 1, "description": "For rolling planning: how many days ahead the schedule remains bookable."}, "planning_period_from": {"type": "string", "format": "date", "example": "2019-01-01", "description": "For fixed-range planning: first date bookings are accepted for."}, "planning_period_to": {"type": "string", "format": "date", "example": "2019-01-01", "description": "For fixed-range planning: last date bookings are accepted for."}, "planning_type": {"type": "integer", "description": "How far ahead bookings are accepted (e.g. RollingDays, FixedRange).\n\nInteger enum value: 0 - Infinite, 1 - Offset, 2 - Period", "example": 0, "enum": [0, 1, 2]}, "reminder_email_enabled": {"type": "boolean", "example": false, "description": "True when a reminder email is sent to invitees ahead of the booked appointment."}, "reminder_email_offset": {"type": "integer", "format": "int32", "example": 1, "description": "Time before the appointment when the reminder email is sent. Interpreted using reminder_email_offset_type."}, "reminder_email_offset_type": {"type": "integer", "description": "Unit of reminder_email_offset (e.g. Minutes, Hours, Days).\n\nInteger enum value: 0 - Minute, 1 - Hour, 2 - Day, 3 - Week", "example": 0, "enum": [0, 1, 2, 3]}, "reply_company_email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the reply company email."}, "schedule_name": {"type": "string", "example": "string", "description": "Public-facing name of the schedule, shown to bookers on the booking page."}, "time_increment": {"type": "integer", "format": "int32", "example": 1, "description": "Step in minutes between offered start times (e.g. 15 means slots at :00, :15, :30, :45)."}, "type": {"type": "integer", "description": "Schedule type (e.g. one-on-one or round-robin).\n\nInteger enum value: 0 - OneToOne, 1 - Group", "example": 0, "enum": [0, 1]}, "url": {"type": "string", "example": "string", "description": "Public URL slug of the schedule, used to share the booking page."}, "additional_fields_data": {"type": "array", "items": {"type": "object", "properties": {"field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Field id"}, "label": {"type": "string", "example": "string", "description": "Field label"}, "is_required": {"type": "boolean", "example": false, "description": "Whether value may be null/empty"}}, "required": ["field_id", "label", "is_required"]}, "description": "Custom fields the booker is asked to fill in on the booking page, in display order."}, "availability_data": {"type": "object", "description": "Weekly availability windows (per weekday) used to compute bookable slots, in the schedule's availability_tzid timezone."}, "appointment_invitees_data": {"type": "array", "items": {"type": "object", "properties": {"entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Entity id or null"}, "email": {"type": "string", "example": "string", "description": "Email address"}, "type": {"type": "integer", "description": "Integer enum value: 1 - Client, 2 - Contact, 3 - Email", "example": 1, "enum": [1, 2, 3]}}, "required": ["email", "type"]}, "description": "Default invitees added to appointments booked through this schedule (Pipeliner users or external email addresses)."}}, "required": ["appointment_description", "appointment_location", "appointment_owner_id", "appointment_subject", "appointment_subject_uses_schedule_name", "appointment_type_id", "buffer_time_after", "buffer_time_before", "is_enabled", "minimum_notice_time", "name", "owner_id", "planning_day_offset", "reminder_email_enabled", "reminder_email_offset", "schedule_name", "time_increment", "url", "additional_fields_data", "availability_data", "appointment_invitees_data"]}, "updateAppointmentScheduleInput": {"properties": {"appointment_description": {"type": "string", "example": "string", "description": "Description applied to appointments booked through this schedule."}, "appointment_duration": {"type": "number", "format": "double", "example": "4.32", "description": "Duration of each booked appointment."}, "appointment_location": {"type": "string", "example": "string", "description": "Location applied to appointments booked through this schedule."}, "appointment_location_type": {"type": "integer", "description": "How the location is interpreted (e.g. PhysicalAddress, OnlineMeeting).\n\nInteger enum value: 0 - Custom, 1 - Microsoft, 2 - Zoom", "example": 0, "enum": [0, 1, 2]}, "appointment_owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user receiving the booking."}, "appointment_subject": {"type": "string", "example": "string", "description": "Subject applied to appointments booked through this schedule."}, "appointment_subject_uses_schedule_name": {"type": "boolean", "example": false, "description": "When true, booked appointments use the schedule_name as their subject instead of appointment_subject."}, "appointment_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment type."}, "availability_tzid": {"type": "string", "example": "string", "description": "IANA timezone (e.g. \"Europe/Bratislava\") in which availability windows are defined."}, "buffer_time_after": {"type": "integer", "format": "int32", "example": 1, "description": "Minutes of buffer reserved after each booked appointment."}, "buffer_time_before": {"type": "integer", "format": "int32", "example": 1, "description": "Minutes of buffer reserved before each booked appointment."}, "confirmation_page_type": {"type": "integer", "description": "What is shown to the booker after confirming (e.g. default Coevera page or a custom redirect URL).\n\nInteger enum value: 0 - ConfirmationPage, 1 - ExternalUrl", "example": 0, "enum": [0, 1]}, "confirmation_page_url": {"type": "string", "example": "string", "description": "Custom URL the booker is redirected to after confirming. Used when confirmation_page_type selects a custom redirect."}, "is_enabled": {"type": "boolean", "example": false, "description": "Master switch for the schedule. Disabled schedules do not accept new bookings."}, "minimum_notice_time": {"type": "integer", "format": "int32", "example": 1, "description": "Minimum notice in hours required before a slot can be booked."}, "name": {"type": "string", "example": "string", "description": "Admin-only name for the schedule, used in pickers and lists. Not shown to bookers; use schedule_name for the public-facing name."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the schedule owner."}, "planning_day_offset": {"type": "integer", "format": "int32", "example": 1, "description": "For rolling planning: how many days ahead the schedule remains bookable."}, "planning_period_from": {"type": "string", "format": "date", "example": "2019-01-01", "description": "For fixed-range planning: first date bookings are accepted for."}, "planning_period_to": {"type": "string", "format": "date", "example": "2019-01-01", "description": "For fixed-range planning: last date bookings are accepted for."}, "planning_type": {"type": "integer", "description": "How far ahead bookings are accepted (e.g. RollingDays, FixedRange).\n\nInteger enum value: 0 - Infinite, 1 - Offset, 2 - Period", "example": 0, "enum": [0, 1, 2]}, "reminder_email_enabled": {"type": "boolean", "example": false, "description": "True when a reminder email is sent to invitees ahead of the booked appointment."}, "reminder_email_offset": {"type": "integer", "format": "int32", "example": 1, "description": "Time before the appointment when the reminder email is sent. Interpreted using reminder_email_offset_type."}, "reminder_email_offset_type": {"type": "integer", "description": "Unit of reminder_email_offset (e.g. Minutes, Hours, Days).\n\nInteger enum value: 0 - Minute, 1 - Hour, 2 - Day, 3 - Week", "example": 0, "enum": [0, 1, 2, 3]}, "reply_company_email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the reply company email."}, "schedule_name": {"type": "string", "example": "string", "description": "Public-facing name of the schedule, shown to bookers on the booking page."}, "time_increment": {"type": "integer", "format": "int32", "example": 1, "description": "Step in minutes between offered start times (e.g. 15 means slots at :00, :15, :30, :45)."}, "type": {"type": "integer", "description": "Schedule type (e.g. one-on-one or round-robin).\n\nInteger enum value: 0 - OneToOne, 1 - Group", "example": 0, "enum": [0, 1]}, "url": {"type": "string", "example": "string", "description": "Public URL slug of the schedule, used to share the booking page."}, "additional_fields_data": {"type": "array", "items": {"type": "object", "properties": {"field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Field id"}, "label": {"type": "string", "example": "string", "description": "Field label"}, "is_required": {"type": "boolean", "example": false, "description": "Whether value may be null/empty"}}, "required": ["field_id", "label", "is_required"]}, "description": "Custom fields the booker is asked to fill in on the booking page, in display order."}, "availability_data": {"type": "object", "description": "Weekly availability windows (per weekday) used to compute bookable slots, in the schedule's availability_tzid timezone."}, "appointment_invitees_data": {"type": "array", "items": {"type": "object", "properties": {"entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Entity id or null"}, "email": {"type": "string", "example": "string", "description": "Email address"}, "type": {"type": "integer", "description": "Integer enum value: 1 - Client, 2 - Contact, 3 - Email", "example": 1, "enum": [1, 2, 3]}}, "required": ["email", "type"]}, "description": "Default invitees added to appointments booked through this schedule (Pipeliner users or external email addresses)."}}}, "batchAppointmentScheduleInput": {"properties": {"appointment_description": {"type": "string", "example": "string", "description": "Description applied to appointments booked through this schedule."}, "appointment_duration": {"type": "number", "format": "double", "example": "4.32", "description": "Duration of each booked appointment."}, "appointment_location": {"type": "string", "example": "string", "description": "Location applied to appointments booked through this schedule."}, "appointment_location_type": {"type": "integer", "description": "How the location is interpreted (e.g. PhysicalAddress, OnlineMeeting).\n\nInteger enum value: 0 - Custom, 1 - Microsoft, 2 - Zoom", "example": 0, "enum": [0, 1, 2]}, "appointment_owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user receiving the booking."}, "appointment_subject": {"type": "string", "example": "string", "description": "Subject applied to appointments booked through this schedule."}, "appointment_subject_uses_schedule_name": {"type": "boolean", "example": false, "description": "When true, booked appointments use the schedule_name as their subject instead of appointment_subject."}, "appointment_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment type."}, "availability_tzid": {"type": "string", "example": "string", "description": "IANA timezone (e.g. \"Europe/Bratislava\") in which availability windows are defined."}, "buffer_time_after": {"type": "integer", "format": "int32", "example": 1, "description": "Minutes of buffer reserved after each booked appointment."}, "buffer_time_before": {"type": "integer", "format": "int32", "example": 1, "description": "Minutes of buffer reserved before each booked appointment."}, "confirmation_page_type": {"type": "integer", "description": "What is shown to the booker after confirming (e.g. default Coevera page or a custom redirect URL).\n\nInteger enum value: 0 - ConfirmationPage, 1 - ExternalUrl", "example": 0, "enum": [0, 1]}, "confirmation_page_url": {"type": "string", "example": "string", "description": "Custom URL the booker is redirected to after confirming. Used when confirmation_page_type selects a custom redirect."}, "is_enabled": {"type": "boolean", "example": false, "description": "Master switch for the schedule. Disabled schedules do not accept new bookings."}, "minimum_notice_time": {"type": "integer", "format": "int32", "example": 1, "description": "Minimum notice in hours required before a slot can be booked."}, "name": {"type": "string", "example": "string", "description": "Admin-only name for the schedule, used in pickers and lists. Not shown to bookers; use schedule_name for the public-facing name."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the schedule owner."}, "planning_day_offset": {"type": "integer", "format": "int32", "example": 1, "description": "For rolling planning: how many days ahead the schedule remains bookable."}, "planning_period_from": {"type": "string", "format": "date", "example": "2019-01-01", "description": "For fixed-range planning: first date bookings are accepted for."}, "planning_period_to": {"type": "string", "format": "date", "example": "2019-01-01", "description": "For fixed-range planning: last date bookings are accepted for."}, "planning_type": {"type": "integer", "description": "How far ahead bookings are accepted (e.g. RollingDays, FixedRange).\n\nInteger enum value: 0 - Infinite, 1 - Offset, 2 - Period", "example": 0, "enum": [0, 1, 2]}, "reminder_email_enabled": {"type": "boolean", "example": false, "description": "True when a reminder email is sent to invitees ahead of the booked appointment."}, "reminder_email_offset": {"type": "integer", "format": "int32", "example": 1, "description": "Time before the appointment when the reminder email is sent. Interpreted using reminder_email_offset_type."}, "reminder_email_offset_type": {"type": "integer", "description": "Unit of reminder_email_offset (e.g. Minutes, Hours, Days).\n\nInteger enum value: 0 - Minute, 1 - Hour, 2 - Day, 3 - Week", "example": 0, "enum": [0, 1, 2, 3]}, "reply_company_email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the reply company email."}, "schedule_name": {"type": "string", "example": "string", "description": "Public-facing name of the schedule, shown to bookers on the booking page."}, "time_increment": {"type": "integer", "format": "int32", "example": 1, "description": "Step in minutes between offered start times (e.g. 15 means slots at :00, :15, :30, :45)."}, "type": {"type": "integer", "description": "Schedule type (e.g. one-on-one or round-robin).\n\nInteger enum value: 0 - OneToOne, 1 - Group", "example": 0, "enum": [0, 1]}, "url": {"type": "string", "example": "string", "description": "Public URL slug of the schedule, used to share the booking page."}, "additional_fields_data": {"type": "array", "items": {"type": "object", "properties": {"field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Field id"}, "label": {"type": "string", "example": "string", "description": "Field label"}, "is_required": {"type": "boolean", "example": false, "description": "Whether value may be null/empty"}}, "required": ["field_id", "label", "is_required"]}, "description": "Custom fields the booker is asked to fill in on the booking page, in display order."}, "availability_data": {"type": "object", "description": "Weekly availability windows (per weekday) used to compute bookable slots, in the schedule's availability_tzid timezone."}, "appointment_invitees_data": {"type": "array", "items": {"type": "object", "properties": {"entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Entity id or null"}, "email": {"type": "string", "example": "string", "description": "Email address"}, "type": {"type": "integer", "description": "Integer enum value: 1 - Client, 2 - Contact, 3 - Email", "example": 1, "enum": [1, 2, 3]}}, "required": ["email", "type"]}, "description": "Default invitees added to appointments booked through this schedule (Pipeliner users or external email addresses)."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "AppointmentType": {"properties": {"id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing appointments of this type."}, "icon": {"type": "integer", "description": "Icon used to display appointments of this type in the UI.\n\nInteger enum value: 0 - GeneralIcon, 1 - Task, 2 - Appointment, 3 - Call, 4 - Mail, 5 - Message, 6 - TicketingIntegration, 7 - DocumentManagement, 8 - EventManagement, 9 - AccountingSystem, 10 - MarketingCommunicationSystems, 11 - OrderProcessing, 12 - WebServices, 13 - ReturnMerchandiseAuthorizationSystems, 14 - SalesAutomatization, 15 - SmsMessaging, 16 - ErpSystems, 17 - DataAnalytics, 18 - Warehouses, 19 - ContactManagement, 20 - ContentManagementSystems, 21 - InventorySystems, 22 - Workflow, 23 - AssetManagementSystem", "example": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23]}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the appointment type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "is_published": {"type": "boolean", "example": false, "description": "True when the entity configuration is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "has_draft": {"type": "boolean", "example": false, "description": "Set to True if draft for entity exists and can be published"}, "is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "form_edit_api": {"type": "object", "description": "API-friendly form definition. Returns the published form merged with any pending draft changes; read via this field, modify via the underlying form_edit / form_lost field through drafts."}, "can_change_readonly": {"type": "boolean", "example": false, "description": "Returns if user can change readonly flag on this entity_type."}}, "required": ["id", "is_readonly", "name", "has_draft", "is_delete_protected", "form_edit_api"]}, "createAppointmentTypeInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing appointments of this type."}, "icon": {"type": "integer", "description": "Icon used to display appointments of this type in the UI.\n\nInteger enum value: 0 - GeneralIcon, 1 - Task, 2 - Appointment, 3 - Call, 4 - Mail, 5 - Message, 6 - TicketingIntegration, 7 - DocumentManagement, 8 - EventManagement, 9 - AccountingSystem, 10 - MarketingCommunicationSystems, 11 - OrderProcessing, 12 - WebServices, 13 - ReturnMerchandiseAuthorizationSystems, 14 - SalesAutomatization, 15 - SmsMessaging, 16 - ErpSystems, 17 - DataAnalytics, 18 - Warehouses, 19 - ContactManagement, 20 - ContentManagementSystems, 21 - InventorySystems, 22 - Workflow, 23 - AssetManagementSystem", "example": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23]}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the appointment type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "is_published": {"type": "boolean", "example": false, "description": "True when the entity configuration is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_readonly", "name"]}, "updateAppointmentTypeInput": {"properties": {"form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing appointments of this type."}, "icon": {"type": "integer", "description": "Icon used to display appointments of this type in the UI.\n\nInteger enum value: 0 - GeneralIcon, 1 - Task, 2 - Appointment, 3 - Call, 4 - Mail, 5 - Message, 6 - TicketingIntegration, 7 - DocumentManagement, 8 - EventManagement, 9 - AccountingSystem, 10 - MarketingCommunicationSystems, 11 - OrderProcessing, 12 - WebServices, 13 - ReturnMerchandiseAuthorizationSystems, 14 - SalesAutomatization, 15 - SmsMessaging, 16 - ErpSystems, 17 - DataAnalytics, 18 - Warehouses, 19 - ContactManagement, 20 - ContentManagementSystems, 21 - InventorySystems, 22 - Workflow, 23 - AssetManagementSystem", "example": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23]}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the appointment type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchAppointmentTypeInput": {"properties": {"form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing appointments of this type."}, "icon": {"type": "integer", "description": "Icon used to display appointments of this type in the UI.\n\nInteger enum value: 0 - GeneralIcon, 1 - Task, 2 - Appointment, 3 - Call, 4 - Mail, 5 - Message, 6 - TicketingIntegration, 7 - DocumentManagement, 8 - EventManagement, 9 - AccountingSystem, 10 - MarketingCommunicationSystems, 11 - OrderProcessing, 12 - WebServices, 13 - ReturnMerchandiseAuthorizationSystems, 14 - SalesAutomatization, 15 - SmsMessaging, 16 - ErpSystems, 17 - DataAnalytics, 18 - Warehouses, 19 - ContactManagement, 20 - ContentManagementSystems, 21 - InventorySystems, 22 - Workflow, 23 - AssetManagementSystem", "example": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23]}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the appointment type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Approval": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account": {"type": "string", "format": "uri", "description": "Account the approval is requested on, when the trigger record is an Account.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "actor": {"type": "string", "format": "uri", "description": "User who triggered the approval, or empty when triggered automatically.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "application": {"type": "string", "format": "uri", "description": "Application context the approval was triggered in.\n\nRelation to Application. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Application' object for properties."}, "approval_process": {"type": "string", "format": "uri", "description": "Approval process this approval was raised from.\n\nRelation to ApprovalProcess. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ApprovalProcess' object for properties."}, "contact": {"type": "string", "format": "uri", "description": "Contact the approval is requested on, when the trigger record is a Contact.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "lead": {"type": "string", "format": "uri", "description": "Lead the approval is requested on. Set when lead_oppty_id resolves to a Lead.\n\nRelation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties."}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity the approval is requested on. Set when lead_oppty_id resolves to an Opportunity.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "quote": {"type": "string", "format": "uri", "description": "Quote the approval is requested on, when the trigger record is a Quote.\n\nRelation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "actor_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the triggering user."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the application."}, "approval_process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the approval process."}, "approval_status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Pending, 1 - Approved, 2 - Rejected", "example": 0, "enum": [0, 1, 2]}, "comment": {"type": "string", "example": "string", "description": "Comment the requester attached when raising the approval."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "end_time": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the approval reached a final status (Approved/Rejected/Cancelled). Empty while the approval is still pending."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity, or empty when not linked."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "settings": {"type": "object", "description": "Snapshot of the approval process schema at the time the approval was raised. Frozen so subsequent changes to the parent approval process do not affect this run."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "approvers": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ApprovalApprover. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ApprovalApprover' object for properties."}, "description": "Users who must respond to the approval, with their individual responses."}, "lines": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ApprovalProcessActivityLogLine. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ApprovalProcessActivityLogLine' object for properties."}, "description": "Activity log lines describing the steps taken on this approval (visible only)."}, "start_time": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the approval was raised (alias of created)."}}, "required": ["is_delete_protected", "id", "application", "approval_process", "application_id", "approval_process_id", "settings"]}, "createApprovalInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "actor_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the triggering user."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the application."}, "approval_process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the approval process."}, "approval_status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Pending, 1 - Approved, 2 - Rejected", "example": 0, "enum": [0, 1, 2]}, "comment": {"type": "string", "example": "string", "description": "Comment the requester attached when raising the approval."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity, or empty when not linked."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "approvers": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ApprovalApprover, see: 'createApprovalApproverInput' object for properties."}, "description": "Users who must respond to the approval, with their individual responses."}}, "required": ["application_id", "approval_process_id"]}, "updateApprovalInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "actor_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the triggering user."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the application."}, "approval_process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the approval process."}, "approval_status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Pending, 1 - Approved, 2 - Rejected", "example": 0, "enum": [0, 1, 2]}, "comment": {"type": "string", "example": "string", "description": "Comment the requester attached when raising the approval."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity, or empty when not linked."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "approvers": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ApprovalApprover, see: 'updateApprovalApproverInput' object for properties."}, "description": "Users who must respond to the approval, with their individual responses."}}}, "batchApprovalInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "actor_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the triggering user."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the application."}, "approval_process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the approval process."}, "approval_status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Pending, 1 - Approved, 2 - Rejected", "example": 0, "enum": [0, 1, 2]}, "comment": {"type": "string", "example": "string", "description": "Comment the requester attached when raising the approval."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity, or empty when not linked."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "approvers": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ApprovalApprover, see: 'updateApprovalApproverInput' object for properties."}, "description": "Users who must respond to the approval, with their individual responses."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ApprovalApprover": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "approval": {"type": "string", "format": "uri", "description": "Approval this approver is assigned to.\n\nRelation to Approval. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Approval' object for properties."}, "client": {"type": "string", "format": "uri", "description": "User responsible for approving (or rejecting) the request.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "approval_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the approval."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the assigned user."}, "comment": {"type": "string", "example": "string", "description": "Comment the user attached when responding to the approval."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Pending, 1 - Approved, 2 - Rejected", "example": 0, "enum": [0, 1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "approval", "client", "approval_id", "client_id"]}, "createApprovalApproverInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "approval_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the approval."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the assigned user."}, "comment": {"type": "string", "example": "string", "description": "Comment the user attached when responding to the approval."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Pending, 1 - Approved, 2 - Rejected", "example": 0, "enum": [0, 1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["approval_id", "client_id"]}, "updateApprovalApproverInput": {"properties": {"approval_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the approval."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the assigned user."}, "comment": {"type": "string", "example": "string", "description": "Comment the user attached when responding to the approval."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Pending, 1 - Approved, 2 - Rejected", "example": 0, "enum": [0, 1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchApprovalApproverInput": {"properties": {"approval_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the approval."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the assigned user."}, "comment": {"type": "string", "example": "string", "description": "Comment the user attached when responding to the approval."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Pending, 1 - Approved, 2 - Rejected", "example": 0, "enum": [0, 1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ApprovalProcess": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "owner": {"type": "string", "format": "uri", "description": "User who owns the approval process.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "description": {"type": "string", "example": "string", "description": "Free-text description shown alongside the approval process."}, "entity_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12], "readOnly": true}, "is_enabled": {"type": "boolean", "example": false, "description": "When true, the approval process actively raises approvals on matching record events; when false, the process is paused."}, "last_schema_change": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent change to settings."}, "last_status_change": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent change to is_enabled."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "priority": {"type": "integer", "format": "int32", "example": 1, "description": "Position of this process among approval processes for the same record-trigger entity type; lower values are evaluated first. Read-only; managed via update_priority. Null for manual-trigger approval processes."}, "settings": {"type": "object", "description": "Approval process schema as a JSON object conforming to the ApprovalProcessSchema type \u2014 trigger, filter, approver settings, and approve/reject nodes. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/approvalprocessschema.doc.html"}, "documents": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties."}, "description": "Files attached to the approval process (e.g. process documentation)."}, "activity_logs": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to Approval. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Approval' object for properties."}, "description": "Approvals (one per process run) raised by this approval process."}}, "required": ["is_delete_protected", "id", "owner", "is_enabled", "name", "owner_id"]}, "createApprovalProcessInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "description": {"type": "string", "example": "string", "description": "Free-text description shown alongside the approval process."}, "is_enabled": {"type": "boolean", "example": false, "description": "When true, the approval process actively raises approvals on matching record events; when false, the process is paused."}, "last_schema_change": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent change to settings."}, "last_status_change": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent change to is_enabled."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "settings": {"type": "object", "description": "Approval process schema as a JSON object conforming to the ApprovalProcessSchema type \u2014 trigger, filter, approver settings, and approve/reject nodes. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/approvalprocessschema.doc.html"}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties."}, "description": "Files attached to the approval process (e.g. process documentation)."}}, "required": ["is_enabled", "name", "owner_id"]}, "updateApprovalProcessInput": {"properties": {"description": {"type": "string", "example": "string", "description": "Free-text description shown alongside the approval process."}, "is_enabled": {"type": "boolean", "example": false, "description": "When true, the approval process actively raises approvals on matching record events; when false, the process is paused."}, "last_schema_change": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent change to settings."}, "last_status_change": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent change to is_enabled."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "settings": {"type": "object", "description": "Approval process schema as a JSON object conforming to the ApprovalProcessSchema type \u2014 trigger, filter, approver settings, and approve/reject nodes. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/approvalprocessschema.doc.html"}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Files attached to the approval process (e.g. process documentation)."}}}, "batchApprovalProcessInput": {"properties": {"description": {"type": "string", "example": "string", "description": "Free-text description shown alongside the approval process."}, "is_enabled": {"type": "boolean", "example": false, "description": "When true, the approval process actively raises approvals on matching record events; when false, the process is paused."}, "last_schema_change": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent change to settings."}, "last_status_change": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent change to is_enabled."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "settings": {"type": "object", "description": "Approval process schema as a JSON object conforming to the ApprovalProcessSchema type \u2014 trigger, filter, approver settings, and approve/reject nodes. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/approvalprocessschema.doc.html"}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Files attached to the approval process (e.g. process documentation)."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ApprovalProcessActivityLogLine": {"properties": {"formatted_text": {"type": "string", "example": "string", "description": "Human-readable rendering of the log line, prefixed with the line's timestamp and (when applicable) the parent record id."}, "is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "approval": {"type": "string", "format": "uri", "description": "Approval this log line belongs to.\n\nRelation to Approval. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Approval' object for properties."}, "approval_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the approval."}, "data": {"type": "object", "description": "Typed JSON payload describing the approval step (e.g. approver decisions, comments)."}, "executed_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run."}, "is_visible": {"type": "boolean", "example": false, "description": "True when the line is shown in the activity log UI; false for internal-only lines."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the line within its approval run."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}}, "required": ["formatted_text", "is_delete_protected", "id", "approval", "approval_id", "data", "sort_order"]}, "createApprovalProcessActivityLogLineInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "approval_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the approval."}, "data": {"type": "object", "description": "Typed JSON payload describing the approval step (e.g. approver decisions, comments)."}, "executed_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run."}, "is_visible": {"type": "boolean", "example": false, "description": "True when the line is shown in the activity log UI; false for internal-only lines."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the line within its approval run."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}}, "required": ["approval_id", "data", "sort_order"]}, "updateApprovalProcessActivityLogLineInput": {"properties": {"approval_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the approval."}, "data": {"type": "object", "description": "Typed JSON payload describing the approval step (e.g. approver decisions, comments)."}, "executed_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run."}, "is_visible": {"type": "boolean", "example": false, "description": "True when the line is shown in the activity log UI; false for internal-only lines."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the line within its approval run."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}}}, "batchApprovalProcessActivityLogLineInput": {"properties": {"approval_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the approval."}, "data": {"type": "object", "description": "Typed JSON payload describing the approval step (e.g. approver decisions, comments)."}, "executed_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run."}, "is_visible": {"type": "boolean", "example": false, "description": "True when the line is shown in the activity log UI; false for internal-only lines."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the line within its approval run."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Call": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account": {"type": "string", "format": "uri", "description": "Account the call is linked to, when applicable.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "caller": {"type": "string", "format": "uri", "description": "User who initiated the call.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "client": {"type": "string", "format": "uri", "description": "User the call was made with, when the call was an internal user-to-user call.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "contact": {"type": "string", "format": "uri", "description": "Contact the call is linked to, when applicable.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "lead": {"type": "string", "format": "uri", "description": "Lead the call is linked to, when the call is associated with a lead.\n\nRelation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties."}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity the call is linked to, when the call is associated with an opportunity.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "oppty_product_relation": {"type": "string", "format": "uri", "description": "Specific opportunity line-item discussed on the call, when applicable.\n\nRelation to OpptyProductRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelation' object for properties."}, "product": {"type": "string", "format": "uri", "description": "Product discussed on the call, when applicable.\n\nRelation to Product. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Product' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "caller_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the calling user."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user the call was made with."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity, or empty when not linked."}, "oppty_product_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked opportunity product line-item."}, "phone_number": {"type": "string", "example": "string", "description": "External phone number called or received, in E.164 format."}, "product_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked product."}, "transcription_id": {"type": "string", "example": "string", "description": "External transcription identifier from the calling provider."}, "transcription_language": {"type": "string", "example": "string", "description": "Language requested for the transcription as a BCP-47 locale tag (e.g. \"en-US\")."}, "transcription_summary": {"type": "string", "example": "string", "description": "AI-generated summary of the call transcription."}, "twilio_call_log_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the call-log record from the calling provider that this call is associated with."}, "transcription_file_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the cloud object holding the transcription payload, when available."}, "audio_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the cloud object holding the call audio recording, when available."}, "twilio_call_sid": {"type": "string", "example": "string", "description": "External call identifier from the calling provider (e.g. Twilio Call SID)."}, "audio_status": {"type": "string", "example": "NoRecording", "enum": ["NoRecording", "TranscriptionCompleted", "TranscriptionEmpty", "TranscriptionError", "TranscriptionInProgress", "UploadError", "Uploaded", "Uploading"], "description": "This is a small hack to force creation of MediaEntity upon Call creation.\n        This field cannot be actually set. Instead, CallRepository.create method handles media creation,\n        if requested."}}, "required": ["is_delete_protected", "id", "caller", "caller_id", "twilio_call_log_id", "twilio_call_sid", "audio_status"]}, "createCallInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "oppty_product_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Specific opportunity line-item discussed on the call, when applicable.\n\nRelation to OpptyProductRelation, see: 'createOpptyProductRelationInput' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "caller_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the calling user."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user the call was made with."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity, or empty when not linked."}, "oppty_product_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked opportunity product line-item."}, "phone_number": {"type": "string", "example": "string", "description": "External phone number called or received, in E.164 format."}, "product_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked product."}, "transcription_id": {"type": "string", "example": "string", "description": "External transcription identifier from the calling provider."}, "transcription_language": {"type": "string", "example": "string", "description": "Language requested for the transcription as a BCP-47 locale tag (e.g. \"en-US\")."}, "transcription_summary": {"type": "string", "example": "string", "description": "AI-generated summary of the call transcription."}, "twilio_call_log_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the call-log record from the calling provider that this call is associated with."}, "audio_status": {"type": "string", "example": "NoRecording", "enum": ["NoRecording", "TranscriptionCompleted", "TranscriptionEmpty", "TranscriptionError", "TranscriptionInProgress", "UploadError", "Uploaded", "Uploading"], "description": "This is a small hack to force creation of MediaEntity upon Call creation.\n        This field cannot be actually set. Instead, CallRepository.create method handles media creation,\n        if requested."}}, "required": ["caller_id", "twilio_call_log_id", "audio_status"]}, "updateCallInput": {"properties": {"oppty_product_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Specific opportunity line-item discussed on the call, when applicable.\n\nRelation to OpptyProductRelation, see: 'updateOpptyProductRelationInput' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "caller_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the calling user."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user the call was made with."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity, or empty when not linked."}, "oppty_product_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked opportunity product line-item."}, "phone_number": {"type": "string", "example": "string", "description": "External phone number called or received, in E.164 format."}, "product_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked product."}, "transcription_id": {"type": "string", "example": "string", "description": "External transcription identifier from the calling provider."}, "transcription_language": {"type": "string", "example": "string", "description": "Language requested for the transcription as a BCP-47 locale tag (e.g. \"en-US\")."}, "transcription_summary": {"type": "string", "example": "string", "description": "AI-generated summary of the call transcription."}, "twilio_call_log_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the call-log record from the calling provider that this call is associated with."}, "audio_status": {"type": "string", "example": "NoRecording", "enum": ["NoRecording", "TranscriptionCompleted", "TranscriptionEmpty", "TranscriptionError", "TranscriptionInProgress", "UploadError", "Uploaded", "Uploading"], "description": "This is a small hack to force creation of MediaEntity upon Call creation.\n        This field cannot be actually set. Instead, CallRepository.create method handles media creation,\n        if requested."}}}, "batchCallInput": {"properties": {"oppty_product_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Specific opportunity line-item discussed on the call, when applicable.\n\nRelation to OpptyProductRelation, see: 'updateOpptyProductRelationInput' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "caller_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the calling user."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user the call was made with."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity, or empty when not linked."}, "oppty_product_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked opportunity product line-item."}, "phone_number": {"type": "string", "example": "string", "description": "External phone number called or received, in E.164 format."}, "product_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked product."}, "transcription_id": {"type": "string", "example": "string", "description": "External transcription identifier from the calling provider."}, "transcription_language": {"type": "string", "example": "string", "description": "Language requested for the transcription as a BCP-47 locale tag (e.g. \"en-US\")."}, "transcription_summary": {"type": "string", "example": "string", "description": "AI-generated summary of the call transcription."}, "twilio_call_log_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the call-log record from the calling provider that this call is associated with."}, "audio_status": {"type": "string", "example": "NoRecording", "enum": ["NoRecording", "TranscriptionCompleted", "TranscriptionEmpty", "TranscriptionError", "TranscriptionInProgress", "UploadError", "Uploaded", "Uploading"], "description": "This is a small hack to force creation of MediaEntity upon Call creation.\n        This field cannot be actually set. Instead, CallRepository.create method handles media creation,\n        if requested."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ChatConversation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "owner": {"type": "string", "format": "uri", "description": "User the conversation belongs to.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "context": {"type": "string", "format": "binary", "example": "blob", "description": "Record context the conversation was started in (entity type, entity id and the AI screen view). Empty for conversations not bound to a record."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - AiChat, 2 - AiRecordDetail", "example": 1, "enum": [1, 2]}, "messages": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to TextMessage. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TextMessage' object for properties."}, "description": "Messages exchanged in the conversation, in chronological order."}}, "required": ["is_delete_protected", "id", "owner", "owner_id"]}, "createChatConversationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - AiChat, 2 - AiRecordDetail", "example": 1, "enum": [1, 2]}, "messages": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TextMessage, see: 'createTextMessageInput' object for properties."}, "description": "Messages exchanged in the conversation, in chronological order."}}, "required": ["owner_id"]}, "updateChatConversationInput": {"properties": {"owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - AiChat, 2 - AiRecordDetail", "example": 1, "enum": [1, 2]}, "messages": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TextMessage, see: 'updateTextMessageInput' object for properties."}, "description": "Messages exchanged in the conversation, in chronological order."}}}, "batchChatConversationInput": {"properties": {"owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - AiChat, 2 - AiRecordDetail", "example": 1, "enum": [1, 2]}, "messages": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TextMessage, see: 'updateTextMessageInput' object for properties."}, "description": "Messages exchanged in the conversation, in chronological order."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Client": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "default_unit": {"type": "string", "format": "uri", "description": "Default sales unit for the user. New records the user creates are assigned to this unit by default.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "master_right": {"type": "string", "format": "uri", "description": "User role assigned to the user. Determines what features and entities the user can access.\n\nRelation to MasterRight. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MasterRight' object for properties."}, "default_unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the default sales unit."}, "email": {"type": "string", "example": "string", "description": "Email. Readonly information from UserProfile."}, "first_name": {"type": "string", "example": "string", "description": "First name. Readonly information from UserProfile.", "readOnly": true}, "last_active": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the user's most recent login or API request.", "readOnly": true}, "last_name": {"type": "string", "example": "string", "description": "Last name. Readonly information from UserProfile.", "readOnly": true}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the assigned user role."}, "middle_name": {"type": "string", "example": "string", "description": "Middle name. Readonly information from UserProfile.", "readOnly": true}, "phone": {"type": "string", "example": "string", "description": "Phone number. Readonly information from UserProfile.", "readOnly": true}, "picture_url": {"type": "string", "example": "string", "description": "Picture name. Readonly information from UserProfile.", "readOnly": true}, "position": {"type": "string", "example": "string", "description": "Job title or position of the user."}, "region": {"type": "string", "example": "string", "description": "Region. Readonly information from UserProfile.", "readOnly": true}, "timezone": {"type": "string", "example": "string", "description": "Timezone offset (DEPRECATED)Readonly information from UserProfile.", "readOnly": true}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Customer, 1 - Support", "example": 0, "enum": [0, 1]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "default_idp": {"type": "integer", "format": "int32", "example": 1, "description": "default_idp retrieved from user, if enabled [HEAVY]"}, "user_profile_id": {"type": "integer", "format": "int32", "example": 1, "description": "ID of the associated user account [HEAVY]"}, "unit_membership": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to SalesUnitClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnitClientRelation' object for properties."}, "description": "Sales units the user belongs to (as member or manager)."}, "appointment_favorite": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ClientFavorite. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ClientFavorite' object for properties."}, "description": "Appointments marked as favorite by the user."}, "task_favorite": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ClientFavorite. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ClientFavorite' object for properties."}, "description": "Tasks marked as favorite by the user."}, "account_favorite": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ClientFavorite. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ClientFavorite' object for properties."}, "description": "Accounts marked as favorite by the user."}, "contact_favorite": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ClientFavorite. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ClientFavorite' object for properties."}, "description": "Contacts marked as favorite by the user."}, "profile_favorite": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ClientFavorite. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ClientFavorite' object for properties."}, "description": "Screen profiles marked as favorite by the user."}, "report_favorite": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ClientFavorite. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ClientFavorite' object for properties."}, "description": "Reports marked as favorite by the user."}, "lead_favorite": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ClientFavorite. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ClientFavorite' object for properties."}, "description": "Leads marked as favorite by the user."}, "opportunity_favorite": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ClientFavorite. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ClientFavorite' object for properties."}, "description": "Opportunities marked as favorite by the user."}, "timezone_name": {"type": "string", "example": "string", "description": "IANA timezone name from UserProfile"}, "name": {"type": "string", "example": "string", "description": "Display name of the user, formatted according to the user's name format preference."}, "formatted_name": {"type": "string", "example": "string", "description": "Display name of the user (alias of name)."}, "unit_manager_ids": {"type": "array", "items": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000"}, "description": "Ids of all sales units the user manages, expanded to include all descendant units in each managed subtree."}, "unit_member_ids": {"type": "array", "items": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000"}, "description": "Ids of sales units the user belongs to as a member only (not as a manager)."}, "user_recalculation_state": {"type": "string", "example": "InProgress", "enum": ["InProgress", "NoRecalculation", "Pending"], "description": "State of the user's row-level access recalculation: NoRecalculation (up to date), Pending (queued), or InProgress."}}, "required": ["is_delete_protected", "id", "default_unit", "master_right", "default_unit_id", "email", "master_right_id", "unit_membership", "formatted_name", "unit_manager_ids", "unit_member_ids"]}, "createClientInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "default_unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the default sales unit."}, "email": {"type": "string", "example": "string", "description": "Email. Readonly information from UserProfile."}, "first_name": {"type": "string", "example": "string", "description": "First name. Readonly information from UserProfile.", "readOnly": true}, "last_active": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the user's most recent login or API request.", "readOnly": true}, "last_name": {"type": "string", "example": "string", "description": "Last name. Readonly information from UserProfile.", "readOnly": true}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the assigned user role."}, "middle_name": {"type": "string", "example": "string", "description": "Middle name. Readonly information from UserProfile.", "readOnly": true}, "phone": {"type": "string", "example": "string", "description": "Phone number. Readonly information from UserProfile.", "readOnly": true}, "position": {"type": "string", "example": "string", "description": "Job title or position of the user."}, "region": {"type": "string", "example": "string", "description": "Region. Readonly information from UserProfile.", "readOnly": true}, "timezone": {"type": "string", "example": "string", "description": "Timezone offset (DEPRECATED)Readonly information from UserProfile.", "readOnly": true}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Customer, 1 - Support", "example": 0, "enum": [0, 1]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "unit_membership": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to SalesUnitClientRelation, see: 'createSalesUnitClientRelationInput' object for properties."}, "description": "Sales units the user belongs to (as member or manager)."}, "appointment_favorite": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ClientFavorite, see: 'createClientFavoriteInput' object for properties."}, "description": "Appointments marked as favorite by the user."}, "task_favorite": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ClientFavorite, see: 'createClientFavoriteInput' object for properties."}, "description": "Tasks marked as favorite by the user."}, "account_favorite": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ClientFavorite, see: 'createClientFavoriteInput' object for properties."}, "description": "Accounts marked as favorite by the user."}, "contact_favorite": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ClientFavorite, see: 'createClientFavoriteInput' object for properties."}, "description": "Contacts marked as favorite by the user."}, "profile_favorite": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ClientFavorite, see: 'createClientFavoriteInput' object for properties."}, "description": "Screen profiles marked as favorite by the user."}, "report_favorite": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ClientFavorite, see: 'createClientFavoriteInput' object for properties."}, "description": "Reports marked as favorite by the user."}, "lead_favorite": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ClientFavorite, see: 'createClientFavoriteInput' object for properties."}, "description": "Leads marked as favorite by the user."}, "opportunity_favorite": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ClientFavorite, see: 'createClientFavoriteInput' object for properties."}, "description": "Opportunities marked as favorite by the user."}}, "required": ["default_unit_id", "email", "master_right_id", "unit_membership"]}, "updateClientInput": {"properties": {"default_unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the default sales unit."}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the assigned user role."}, "position": {"type": "string", "example": "string", "description": "Job title or position of the user."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Customer, 1 - Support", "example": 0, "enum": [0, 1]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "unit_membership": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to SalesUnitClientRelation, see: 'updateSalesUnitClientRelationInput' object for properties."}, "description": "Sales units the user belongs to (as member or manager)."}, "appointment_favorite": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties."}, "description": "Appointments marked as favorite by the user."}, "task_favorite": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties."}, "description": "Tasks marked as favorite by the user."}, "account_favorite": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties."}, "description": "Accounts marked as favorite by the user."}, "contact_favorite": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties."}, "description": "Contacts marked as favorite by the user."}, "profile_favorite": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties."}, "description": "Screen profiles marked as favorite by the user."}, "report_favorite": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties."}, "description": "Reports marked as favorite by the user."}, "lead_favorite": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties."}, "description": "Leads marked as favorite by the user."}, "opportunity_favorite": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties."}, "description": "Opportunities marked as favorite by the user."}}}, "batchClientInput": {"properties": {"default_unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the default sales unit."}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the assigned user role."}, "position": {"type": "string", "example": "string", "description": "Job title or position of the user."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Customer, 1 - Support", "example": 0, "enum": [0, 1]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "unit_membership": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to SalesUnitClientRelation, see: 'updateSalesUnitClientRelationInput' object for properties."}, "description": "Sales units the user belongs to (as member or manager)."}, "appointment_favorite": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties."}, "description": "Appointments marked as favorite by the user."}, "task_favorite": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties."}, "description": "Tasks marked as favorite by the user."}, "account_favorite": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties."}, "description": "Accounts marked as favorite by the user."}, "contact_favorite": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties."}, "description": "Contacts marked as favorite by the user."}, "profile_favorite": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties."}, "description": "Screen profiles marked as favorite by the user."}, "report_favorite": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties."}, "description": "Reports marked as favorite by the user."}, "lead_favorite": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties."}, "description": "Leads marked as favorite by the user."}, "opportunity_favorite": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ClientFavorite, see: 'updateClientFavoriteInput' object for properties."}, "description": "Opportunities marked as favorite by the user."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ClientExcludedOppty": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity excluded from the user's forecast/quota calculations.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "User who excluded the opportunity from their forecast/quota.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "is_excluded": {"type": "boolean", "example": false, "description": "When true, the opportunity is excluded from the user's forecast/quota; when false, the row records that the user explicitly re-included a previously excluded opportunity."}, "oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "oppty", "owner", "is_excluded", "oppty_id", "owner_id"]}, "createClientExcludedOpptyInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "is_excluded": {"type": "boolean", "example": false, "description": "When true, the opportunity is excluded from the user's forecast/quota; when false, the row records that the user explicitly re-included a previously excluded opportunity."}, "oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_excluded", "oppty_id", "owner_id"]}, "updateClientExcludedOpptyInput": {"properties": {"is_excluded": {"type": "boolean", "example": false, "description": "When true, the opportunity is excluded from the user's forecast/quota; when false, the row records that the user explicitly re-included a previously excluded opportunity."}, "oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchClientExcludedOpptyInput": {"properties": {"is_excluded": {"type": "boolean", "example": false, "description": "When true, the opportunity is excluded from the user's forecast/quota; when false, the row records that the user explicitly re-included a previously excluded opportunity."}, "oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ClientFavorite": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account": {"type": "string", "format": "uri", "description": "Account marked as favorite, when this favorite points to an account.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "appointment": {"type": "string", "format": "uri", "description": "Appointment marked as favorite. Set when activity_id resolves to an Appointment.\n\nRelation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties."}, "task": {"type": "string", "format": "uri", "description": "Task marked as favorite. Set when activity_id resolves to a Task.\n\nRelation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties."}, "contact": {"type": "string", "format": "uri", "description": "Contact marked as favorite, when this favorite points to a contact.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "custom_entity": {"type": "string", "format": "uri", "description": "Custom entity record marked as favorite, when this favorite points to a custom entity.\n\nRelation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties."}, "email": {"type": "string", "format": "uri", "description": "Email marked as favorite, when this favorite points to an email.\n\nRelation to Email. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Email' object for properties."}, "lead": {"type": "string", "format": "uri", "description": "Lead marked as favorite. Set when lead_oppty_id resolves to a Lead.\n\nRelation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties."}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity marked as favorite. Set when lead_oppty_id resolves to an Opportunity.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "User who marked the record as favorite.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "profile": {"type": "string", "format": "uri", "description": "Screen profile marked as favorite, when this favorite points to a profile.\n\nRelation to Profile. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Profile' object for properties."}, "project": {"type": "string", "format": "uri", "description": "Project marked as favorite, when this favorite points to a project.\n\nRelation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties."}, "quote": {"type": "string", "format": "uri", "description": "Quote marked as favorite, when this favorite points to a quote.\n\nRelation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties."}, "report": {"type": "string", "format": "uri", "description": "Report marked as favorite, when this favorite points to a report.\n\nRelation to Report. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Report' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite account."}, "activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite appointment or task, or empty when not pointing to an activity."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite custom entity record."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite email."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite lead or opportunity, or empty when not pointing to one."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "profile_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite screen profile."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite quote."}, "report_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite report."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "owner", "owner_id"]}, "createClientFavoriteInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite account."}, "activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite appointment or task, or empty when not pointing to an activity."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite custom entity record."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite email."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite lead or opportunity, or empty when not pointing to one."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "profile_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite screen profile."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite quote."}, "report_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite report."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["owner_id"]}, "updateClientFavoriteInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite account."}, "activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite appointment or task, or empty when not pointing to an activity."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite custom entity record."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite email."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite lead or opportunity, or empty when not pointing to one."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "profile_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite screen profile."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite quote."}, "report_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite report."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchClientFavoriteInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite account."}, "activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite appointment or task, or empty when not pointing to an activity."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite custom entity record."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite email."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite lead or opportunity, or empty when not pointing to one."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "profile_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite screen profile."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite quote."}, "report_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the favorite report."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ClientSetting": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "owner": {"type": "string", "format": "uri", "description": "User the setting belongs to.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "name": {"type": "string", "example": "string", "description": "Setting key (unique per user)."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "value": {"type": "object", "description": "Setting value, stored as a JSON document."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "owner", "name", "owner_id", "value"]}, "ClientStoryRead": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "appointment": {"type": "string", "format": "uri", "description": "Appointment that was read. Set when activity_id resolves to an Appointment.\n\nRelation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties."}, "task": {"type": "string", "format": "uri", "description": "Task that was read. Set when activity_id resolves to a Task.\n\nRelation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties."}, "email": {"type": "string", "format": "uri", "description": "Email that was read. Set when message_id resolves to an Email.\n\nRelation to Email. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Email' object for properties."}, "memo": {"type": "string", "format": "uri", "description": "Memo that was read. Set when message_id resolves to a Memo.\n\nRelation to Memo. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Memo' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "User who read the activity or message.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the read appointment or task, or empty when this read points to a message."}, "message_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the read email or memo, or empty when this read points to an activity."}, "no_follow": {"type": "boolean", "example": false, "description": "When true, the user explicitly chose not to follow up on this item."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the reading user."}, "read_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the user marked the item as read."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "owner", "owner_id", "read_at"]}, "createClientStoryReadInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the read appointment or task, or empty when this read points to a message."}, "message_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the read email or memo, or empty when this read points to an activity."}, "no_follow": {"type": "boolean", "example": false, "description": "When true, the user explicitly chose not to follow up on this item."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the reading user."}, "read_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the user marked the item as read."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["owner_id", "read_at"]}, "updateClientStoryReadInput": {"properties": {"activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the read appointment or task, or empty when this read points to a message."}, "message_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the read email or memo, or empty when this read points to an activity."}, "no_follow": {"type": "boolean", "example": false, "description": "When true, the user explicitly chose not to follow up on this item."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the reading user."}, "read_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the user marked the item as read."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchClientStoryReadInput": {"properties": {"activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the read appointment or task, or empty when this read points to a message."}, "message_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the read email or memo, or empty when this read points to an activity."}, "no_follow": {"type": "boolean", "example": false, "description": "When true, the user explicitly chose not to follow up on this item."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the reading user."}, "read_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the user marked the item as read."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "CloudObject": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "application": {"type": "string", "format": "uri", "description": "Application that produced the object (e.g. Online Forms).\n\nRelation to Application. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Application' object for properties."}, "company_cloud_object_folder": {"type": "string", "format": "uri", "description": "Company-level folder that contains the object, when stored in the company document tree.\n\nRelation to CloudObjectFolder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectFolder' object for properties."}, "creator": {"type": "string", "format": "uri", "description": "User who uploaded the object.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the producing application."}, "company_cloud_object_folder_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the company folder, or empty when the object is not stored in the company tree."}, "creator_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the uploading user."}, "filename": {"type": "string", "example": "string", "description": "File name (with extension) used when downloading the object."}, "is_public": {"type": "boolean", "example": false, "description": "When true, the object can be served via a public URL (see public_url)."}, "mime_type": {"type": "string", "example": "string", "description": "Mime-type of the cloud object Is detected from content.", "readOnly": true}, "params": {"type": "object", "description": "Additional metadata about the object (e.g. image dimensions, audio duration), as a JSON object."}, "size": {"type": "integer", "format": "int32", "example": 1, "description": "Size of the object in bytes.", "readOnly": true}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: -1 - S3FileUpload, 1 - S3File, 2 - S3Image, 3 - GoogleDriveFile, 4 - OneDriveFile, 5 - BoxFile, 6 - DropboxFile, 7 - SharepointFile, 8 - ExternalURL, 9 - AlfrescoFile, 10 - UrlFile", "example": -1, "enum": [-1, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10], "readOnly": true}, "upload_source": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - EmailTemplate, 2 - RichTextEditor", "example": 1, "enum": [1, 2]}, "url": {"type": "string", "example": "string", "description": "URL of the object. If URL scheme is not defined \"http://\" is automatically prepended to supplied URL.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "dimensions": {"type": "object", "description": "returns dimensions in case of image"}, "duration": {"type": "number", "format": "double", "example": 4.32, "description": "returns duration of audio file in seconds"}, "public_url": {"type": "string", "example": "string", "description": "returns public url for cloud object"}}, "required": ["is_delete_protected", "id", "filename", "size", "type"]}, "createCloudObjectInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the producing application."}, "company_cloud_object_folder_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the company folder, or empty when the object is not stored in the company tree."}, "creator_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the uploading user."}, "filename": {"type": "string", "example": "string", "description": "File name (with extension) used when downloading the object."}, "is_public": {"type": "boolean", "example": false, "description": "When true, the object can be served via a public URL (see public_url)."}, "mime_type": {"type": "string", "example": "string", "description": "Mime-type of the cloud object Is detected from content.", "readOnly": true}, "params": {"type": "object", "description": "Additional metadata about the object (e.g. image dimensions, audio duration), as a JSON object."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: -1 - S3FileUpload, 1 - S3File, 2 - S3Image, 3 - GoogleDriveFile, 4 - OneDriveFile, 5 - BoxFile, 6 - DropboxFile, 7 - SharepointFile, 8 - ExternalURL, 9 - AlfrescoFile, 10 - UrlFile", "example": -1, "enum": [-1, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10], "readOnly": true}, "upload_source": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - EmailTemplate, 2 - RichTextEditor", "example": 1, "enum": [1, 2]}, "url": {"type": "string", "example": "string", "description": "URL of the object. If URL scheme is not defined \"http://\" is automatically prepended to supplied URL.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "content": {"type": "string", "format": "binary", "example": "blob", "description": "Data content of the object."}}, "required": ["filename", "type"]}, "updateCloudObjectInput": {"properties": {"application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the producing application."}, "company_cloud_object_folder_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the company folder, or empty when the object is not stored in the company tree."}, "creator_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the uploading user."}, "filename": {"type": "string", "example": "string", "description": "File name (with extension) used when downloading the object."}, "is_public": {"type": "boolean", "example": false, "description": "When true, the object can be served via a public URL (see public_url)."}, "params": {"type": "object", "description": "Additional metadata about the object (e.g. image dimensions, audio duration), as a JSON object."}, "upload_source": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - EmailTemplate, 2 - RichTextEditor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchCloudObjectInput": {"properties": {"application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the producing application."}, "company_cloud_object_folder_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the company folder, or empty when the object is not stored in the company tree."}, "creator_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the uploading user."}, "filename": {"type": "string", "example": "string", "description": "File name (with extension) used when downloading the object."}, "is_public": {"type": "boolean", "example": false, "description": "When true, the object can be served via a public URL (see public_url)."}, "params": {"type": "object", "description": "Additional metadata about the object (e.g. image dimensions, audio duration), as a JSON object."}, "upload_source": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - EmailTemplate, 2 - RichTextEditor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "CloudObjectFolder": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "online_form_type": {"type": "string", "format": "uri", "description": "Online form template this folder is associated with, when the folder stores form submissions.\n\nRelation to OnlineFormType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineFormType' object for properties."}, "parent_cloud_object_folder": {"type": "string", "format": "uri", "description": "Parent folder, when this folder is nested. Empty for top-level folders.\n\nRelation to CloudObjectFolder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectFolder' object for properties."}, "entity_api_name": {"type": "string", "example": "string", "description": "API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty."}, "entity_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "online_form_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form template, or empty when not associated with a form."}, "parent_cloud_object_folder_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent folder, or empty for top-level folders."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "name"]}, "createCloudObjectFolderInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "entity_api_name": {"type": "string", "example": "string", "description": "API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty."}, "entity_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "online_form_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form template, or empty when not associated with a form."}, "parent_cloud_object_folder_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent folder, or empty for top-level folders."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["name"]}, "updateCloudObjectFolderInput": {"properties": {"entity_api_name": {"type": "string", "example": "string", "description": "API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "online_form_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form template, or empty when not associated with a form."}, "parent_cloud_object_folder_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent folder, or empty for top-level folders."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchCloudObjectFolderInput": {"properties": {"entity_api_name": {"type": "string", "example": "string", "description": "API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "online_form_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form template, or empty when not associated with a form."}, "parent_cloud_object_folder_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent folder, or empty for top-level folders."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "CloudObjectRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account": {"type": "string", "format": "uri", "description": "Account the file is attached to, or empty when not attached to an account.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "appointment": {"type": "string", "format": "uri", "description": "Appointment the file is attached to. Set when activity_id resolves to an Appointment.\n\nRelation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties."}, "task": {"type": "string", "format": "uri", "description": "Task the file is attached to. Set when activity_id resolves to a Task.\n\nRelation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties."}, "approval_process": {"type": "string", "format": "uri", "description": "Approval process the file is attached to.\n\nRelation to ApprovalProcess. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ApprovalProcess' object for properties."}, "call": {"type": "string", "format": "uri", "description": "Call the file is attached to (e.g. a call recording).\n\nRelation to Call. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Call' object for properties."}, "cloud_object_folder": {"type": "string", "format": "uri", "description": "Folder the file is filed under within the parent record, or empty when stored at the record root.\n\nRelation to CloudObjectFolder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectFolder' object for properties."}, "cloud_object": {"type": "string", "format": "uri", "description": "Cloud object (file) being linked.\n\nRelation to CloudObject. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObject' object for properties."}, "contact": {"type": "string", "format": "uri", "description": "Contact the file is attached to, or empty when not attached to a contact.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "custom_entity": {"type": "string", "format": "uri", "description": "Custom entity record the file is attached to.\n\nRelation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties."}, "email_sequence": {"type": "string", "format": "uri", "description": "Email sequence the file is attached to.\n\nRelation to EmailSequence. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailSequence' object for properties."}, "email_template": {"type": "string", "format": "uri", "description": "Email template the file is attached to as a template attachment.\n\nRelation to EmailTemplate. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailTemplate' object for properties."}, "field_mapping": {"type": "string", "format": "uri", "description": "Field mapping the file is attached to (e.g. an import file).\n\nRelation to FieldMapping. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'FieldMapping' object for properties."}, "lead": {"type": "string", "format": "uri", "description": "Lead the file is attached to. Set when lead_oppty_id resolves to a Lead.\n\nRelation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties."}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity the file is attached to. Set when lead_oppty_id resolves to an Opportunity.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "media": {"type": "string", "format": "uri", "description": "Media record the file is attached to.\n\nRelation to Media. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Media' object for properties."}, "email": {"type": "string", "format": "uri", "description": "Email the file is attached to (e.g. an email attachment). Set when message_id resolves to an Email.\n\nRelation to Email. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Email' object for properties."}, "memo": {"type": "string", "format": "uri", "description": "Memo the file is attached to. Set when message_id resolves to a Memo.\n\nRelation to Memo. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Memo' object for properties."}, "online_form_field": {"type": "string", "format": "uri", "description": "Online form field the file was uploaded into.\n\nRelation to Field. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Field' object for properties."}, "online_form": {"type": "string", "format": "uri", "description": "Online form submission the file was uploaded with.\n\nRelation to OnlineForm. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineForm' object for properties."}, "process": {"type": "string", "format": "uri", "description": "Sales process the file is attached to.\n\nRelation to Process. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Process' object for properties."}, "process_template": {"type": "string", "format": "uri", "description": "Sales process template the file is attached to.\n\nRelation to ProcessTemplate. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProcessTemplate' object for properties."}, "project": {"type": "string", "format": "uri", "description": "Project the file is attached to.\n\nRelation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties."}, "quote": {"type": "string", "format": "uri", "description": "Quote the file is attached to.\n\nRelation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties."}, "report_schedule": {"type": "string", "format": "uri", "description": "Report schedule the file is attached to (e.g. an exported report).\n\nRelation to ReportSchedule. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ReportSchedule' object for properties."}, "text_message": {"type": "string", "format": "uri", "description": "Text message (SMS/MMS) the file is attached to.\n\nRelation to TextMessage. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TextMessage' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked appointment or task, or empty when not linked."}, "approval_process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked approval process."}, "call_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked call."}, "cloud_object_folder_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the folder within the parent record, or empty when stored at the record root."}, "cloud_object_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked file."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "email_sequence_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked email sequence."}, "email_template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked email template."}, "field_mapping_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked field mapping."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity, or empty when not linked."}, "media_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked media record."}, "message_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked email or memo, or empty when not linked."}, "online_form_field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form field the file was uploaded into."}, "online_form_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked online form submission."}, "process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked sales process."}, "process_template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked sales process template."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "report_schedule_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked report schedule."}, "text_message_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked text message."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id"]}, "createCloudObjectRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "cloud_object": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Cloud object (file) being linked.\n\nRelation to CloudObject, see: 'createCloudObjectInput' object for properties."}, "report_schedule": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Report schedule the file is attached to (e.g. an exported report).\n\nRelation to ReportSchedule, see: 'createReportScheduleInput' object for properties."}, "text_message": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Text message (SMS/MMS) the file is attached to.\n\nRelation to TextMessage, see: 'createTextMessageInput' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked appointment or task, or empty when not linked."}, "approval_process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked approval process."}, "call_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked call."}, "cloud_object_folder_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the folder within the parent record, or empty when stored at the record root."}, "cloud_object_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked file."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "email_sequence_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked email sequence."}, "email_template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked email template."}, "field_mapping_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked field mapping."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity, or empty when not linked."}, "media_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked media record."}, "message_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked email or memo, or empty when not linked."}, "online_form_field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form field the file was uploaded into."}, "online_form_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked online form submission."}, "process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked sales process."}, "process_template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked sales process template."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "report_schedule_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked report schedule."}, "text_message_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked text message."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "updateCloudObjectRelationInput": {"properties": {"cloud_object": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Cloud object (file) being linked.\n\nRelation to CloudObject, see: 'updateCloudObjectInput' object for properties."}, "report_schedule": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Report schedule the file is attached to (e.g. an exported report).\n\nRelation to ReportSchedule, see: 'updateReportScheduleInput' object for properties."}, "text_message": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Text message (SMS/MMS) the file is attached to.\n\nRelation to TextMessage, see: 'updateTextMessageInput' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked appointment or task, or empty when not linked."}, "approval_process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked approval process."}, "call_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked call."}, "cloud_object_folder_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the folder within the parent record, or empty when stored at the record root."}, "cloud_object_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked file."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "email_sequence_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked email sequence."}, "email_template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked email template."}, "field_mapping_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked field mapping."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity, or empty when not linked."}, "media_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked media record."}, "message_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked email or memo, or empty when not linked."}, "online_form_field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form field the file was uploaded into."}, "online_form_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked online form submission."}, "process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked sales process."}, "process_template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked sales process template."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "report_schedule_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked report schedule."}, "text_message_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked text message."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchCloudObjectRelationInput": {"properties": {"cloud_object": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Cloud object (file) being linked.\n\nRelation to CloudObject, see: 'updateCloudObjectInput' object for properties."}, "report_schedule": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Report schedule the file is attached to (e.g. an exported report).\n\nRelation to ReportSchedule, see: 'updateReportScheduleInput' object for properties."}, "text_message": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Text message (SMS/MMS) the file is attached to.\n\nRelation to TextMessage, see: 'updateTextMessageInput' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked appointment or task, or empty when not linked."}, "approval_process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked approval process."}, "call_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked call."}, "cloud_object_folder_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the folder within the parent record, or empty when stored at the record root."}, "cloud_object_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked file."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "email_sequence_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked email sequence."}, "email_template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked email template."}, "field_mapping_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked field mapping."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity, or empty when not linked."}, "media_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked media record."}, "message_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked email or memo, or empty when not linked."}, "online_form_field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form field the file was uploaded into."}, "online_form_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked online form submission."}, "process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked sales process."}, "process_template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked sales process template."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "report_schedule_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked report schedule."}, "text_message_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked text message."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "CloudObjectStepRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "cloud_object": {"type": "string", "format": "uri", "description": "File attached to the step.\n\nRelation to CloudObject. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObject' object for properties."}, "step": {"type": "string", "format": "uri", "description": "Pipeline step the file is attached to.\n\nRelation to Step. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Step' object for properties."}, "cloud_object_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the attached file."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the file within the step's document list."}, "step_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the pipeline step."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "cloud_object", "step", "step_id"]}, "createCloudObjectStepRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "cloud_object": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "File attached to the step.\n\nRelation to CloudObject, see: 'createCloudObjectInput' object for properties."}, "cloud_object_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the attached file."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the file within the step's document list."}, "step_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the pipeline step."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["cloud_object", "step_id"]}, "updateCloudObjectStepRelationInput": {"properties": {"cloud_object": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "File attached to the step.\n\nRelation to CloudObject, see: 'updateCloudObjectInput' object for properties."}, "cloud_object_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the attached file."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the file within the step's document list."}, "step_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the pipeline step."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchCloudObjectStepRelationInput": {"properties": {"cloud_object": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "File attached to the step.\n\nRelation to CloudObject, see: 'updateCloudObjectInput' object for properties."}, "cloud_object_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the attached file."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the file within the step's document list."}, "step_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the pipeline step."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "CloudObjectTemplate": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "application": {"type": "string", "format": "uri", "description": "Application that produced the object (e.g. Online Forms).\n\nRelation to Application. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Application' object for properties."}, "company_cloud_object_folder": {"type": "string", "format": "uri", "description": "Company-level folder that contains the object, when stored in the company document tree.\n\nRelation to CloudObjectFolder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectFolder' object for properties."}, "creator": {"type": "string", "format": "uri", "description": "User who uploaded the object.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the producing application."}, "company_cloud_object_folder_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the company folder, or empty when the object is not stored in the company tree."}, "creator_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the uploading user."}, "filename": {"type": "string", "example": "string", "description": "File name (with extension) used when downloading the object."}, "is_public": {"type": "boolean", "example": false, "description": "When true, the object can be served via a public URL (see public_url)."}, "mime_type": {"type": "string", "example": "string", "description": "Mime-type of the cloud object Is detected from content.", "readOnly": true}, "size": {"type": "integer", "format": "int32", "example": 1, "description": "Size of the object in bytes.", "readOnly": true}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Active, 2 - Inactive", "example": 1, "enum": [1, 2]}, "template_entity_name": {"type": "string", "example": "Account", "enum": ["Account", "AccountDataExRelation", "AccountKPI", "AccountProductPricing", "AccountRole", "AccountSharingClientRelation", "AccountSharingSalesUnitRelation", "AccountSocialRelation", "AccountType", "Activity", "ActivityComment", "ActivityDataExRelation", "ActivityDetail", "ActivityKPI", "ActivityRelation", "ActivityType", "AiAgent", "AiBalance", "AiEvent", "AiEventJournal", "AllowedAccountType", "AllowedCompanyPhone", "AllowedContactType", "AllowedLeadType", "AllowedPipeline", "AllowedQuoteType", "ApiAccess", "Application", "Appointment", "AppointmentClientInviteesRelation", "AppointmentContactInviteesRelation", "AppointmentInviteeNotifyQueue", "AppointmentReminder", "AppointmentSchedule", "AppointmentType", "Approval", "ApprovalApprover", "ApprovalProcess", "ApprovalProcessActivityLogLine", "AuditLog", "AutomationHubApp", "AutomationHubCategory", "AutomationHubItem", "ChatConversation", "Client", "ClientExcludedOppty", "ClientFavorite", "ClientSetting", "ClientStoryRead", "CloudObject", "CloudObjectFolder", "CloudObjectRelation", "CloudObjectStepRelation", "CloudObjectTemplate", "CompanyEmail", "Contact", "ContactAccountAccountRoleRelation", "ContactAccountRelation", "ContactDataExRelation", "ContactKPI", "ContactRelation", "ContactRelationType", "ContactSharingClientRelation", "ContactSharingSalesUnitRelation", "ContactSocialRelation", "ContactType", "Country", "CountryCrm", "CpActivity", "CpCallLog", "CpCalling", "CpClient", "CpProduct", "CpProfile", "CpTeamSpaceClient", "Currency", "CurrencyExchangeRate", "CurrencyExchangeRatesList", "CustomEntity", "CustomEntityDataExRelation", "CustomEntityKPI", "CustomEntityRelation", "CustomEntityRelationData", "CustomEntitySharingClientRelation", "CustomEntitySharingSalesUnitRelation", "CustomEntityType", "Data", "Ebook", "Email", "EmailContentSharingClientRelation", "EmailContentSharingSalesUnitRelation", "EmailMailboxRelation", "EmailSequence", "EmailSequenceActivityLog", "EmailSequenceActivityLogLine", "EmailSequenceEnrolled", "EmailSequenceEnrolledStatus", "EmailSequenceSettings", "EmailTemplate", "EmailTemplateFolder", "EmailTemplateSharingClientRelation", "EmailTemplateSharingSalesUnitRelation", "EmailThreadMailboxClientReadState", "Entity", "EntityFitness", "EntityFitnessIndicator", "EntityHealth", "EntityHealthSettingsHistory", "EntityScoring", "EntitySettings", "EntityType", "Field", "FieldMapping", "FieldPermission", "FieldSequence", "Forecast", "ForecastSharingClientRelation", "ForecastSharingSalesUnitRelation", "FormView", "FormViewSharingClientRelation", "FormViewSharingSalesUnitRelation", "GhostContact", "GhostContactAccountAccountRoleRelation", "GhostContactAccountRelation", "GhostLeadOpptyContactRelation", "GhostLeadOpptyContactSalesRoleRelation", "HowTo", "ImportMappingMask", "InterfacePreview", "Lead", "LeadOppty", "LeadOpptyAccountRelation", "LeadOpptyContactGroupRelation", "LeadOpptyContactRelation", "LeadOpptyContactSalesRoleRelation", "LeadOpptyDataExRelation", "LeadOpptyKPI", "LeadOpptyProjectRelation", "LeadOpptySharingClientRelation", "LeadOpptySharingSalesUnitRelation", "LeadOpptyStepCheckListRelation", "LeadOpptyType", "LeadProcess", "LeadType", "MasterRight", "Media", "Memo", "MemoComment", "Message", "MessageRelation", "MessageSharingClientRelation", "MessageSharingSalesUnitRelation", "Note", "NotificationSetting", "OnlineForm", "OnlineFormActivityLogLine", "OnlineFormDataExRelation", "OnlineFormRelation", "OnlineFormStyle", "OnlineFormType", "OnlineFormTypeEmailRelation", "Opportunity", "OpportunityType", "OpptyProductRelation", "OpptyProductRelationDataExRelation", "OpptyProductRelationRevenueSchedule", "OpptyProductRelationRevenueSchedulePeriod", "OpptyProductRelationType", "OpptyRecurrence", "OpptyRevenueSchedule", "OpptyRevenueSchedulePeriod", "Order", "OrderHistory", "OrderItem", "OrderRelatedDocument", "OrderTempData", "OrderTempDataItem", "ParentAccountRelationType", "Partner", "Payment", "PaymentAdditionalData", "PaymentTerm", "Phone", "Pipeline", "Process", "ProcessActivityLog", "ProcessActivityLogLine", "ProcessChangeOwnerLog", "ProcessScheduledAction", "ProcessTemplate", "Product", "ProductCategory", "ProductDataExRelation", "ProductPipelineRelation", "ProductPriceList", "ProductPriceListPrice", "ProductType", "Profile", "ProfileDraft", "ProfileRelation", "ProfileSharingClientRelation", "ProfileSharingSalesUnitRelation", "Project", "ProjectContactRelation", "ProjectDataExRelation", "ProjectKPI", "ProjectObjective", "ProjectSharingClientRelation", "ProjectSharingSalesUnitRelation", "ProjectType", "PurchasedProduct", "Quote", "QuoteAccountRelation", "QuoteContactRelation", "QuoteDataExRelation", "QuoteKPI", "QuoteProcess", "QuoteSharingClientRelation", "QuoteSharingSalesUnitRelation", "QuoteType", "ReleaseNote", "Report", "ReportFolder", "ReportSchedule", "ReportSharingClientRelation", "ReportSharingSalesUnitRelation", "RevenueRecognition", "SalesRole", "SalesUnit", "SalesUnitClientRelation", "SapiUser", "SpaceSetting", "State", "Step", "StepChecklist", "StepChecklistSalesRoleRelation", "Storylane", "Subscription", "SubscriptionHubItem", "SubscriptionNotification", "SubscriptionRepresentative", "SubscriptionSDR", "Supplier", "Tag", "TagRelation", "Target", "TargetRelation", "Task", "TaskRecurrence", "TaskReminder", "TaskSharingClientRelation", "TaskSharingSalesUnitRelation", "TaskType", "TeamPipelineHubItem", "TeamPipelineHubItemBase", "TeamSpace", "TeamSpaceClient", "TeamSpaceClientSetting", "TeamSpaceProperty", "TeamSpaceRegion", "TextMessage", "TextMessageConversation", "TextMessageConversationRelations", "Timeframe", "Translation", "Type", "UnsubscribedPhone", "UseCase", "UserProfile", "UserRole", "Webhook", "WebhookEvent", "Webresource"], "description": "Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is \"CustomEntity\" and the API name is exposed via template_entity_api_name."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: -1 - S3FileUpload, 1 - S3File, 2 - S3Image, 3 - GoogleDriveFile, 4 - OneDriveFile, 5 - BoxFile, 6 - DropboxFile, 7 - SharepointFile, 8 - ExternalURL, 9 - AlfrescoFile, 10 - UrlFile", "example": -1, "enum": [-1, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10], "readOnly": true}, "upload_source": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - EmailTemplate, 2 - RichTextEditor", "example": 1, "enum": [1, 2]}, "url": {"type": "string", "example": "string", "description": "URL of the object. If URL scheme is not defined \"http://\" is automatically prepended to supplied URL.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "template_entity_api_name": {"type": "string", "example": "string", "description": "API name of the custom entity the template renders. Set only when template_entity_name is \"CustomEntity\"; otherwise empty."}}, "required": ["is_delete_protected", "id", "filename", "size", "template_entity_name", "type"]}, "createCloudObjectTemplateInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the producing application."}, "company_cloud_object_folder_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the company folder, or empty when the object is not stored in the company tree."}, "creator_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the uploading user."}, "filename": {"type": "string", "example": "string", "description": "File name (with extension) used when downloading the object."}, "is_public": {"type": "boolean", "example": false, "description": "When true, the object can be served via a public URL (see public_url)."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Active, 2 - Inactive", "example": 1, "enum": [1, 2]}, "template_entity_name": {"type": "string", "example": "Account", "enum": ["Account", "AccountDataExRelation", "AccountKPI", "AccountProductPricing", "AccountRole", "AccountSharingClientRelation", "AccountSharingSalesUnitRelation", "AccountSocialRelation", "AccountType", "Activity", "ActivityComment", "ActivityDataExRelation", "ActivityDetail", "ActivityKPI", "ActivityRelation", "ActivityType", "AiAgent", "AiBalance", "AiEvent", "AiEventJournal", "AllowedAccountType", "AllowedCompanyPhone", "AllowedContactType", "AllowedLeadType", "AllowedPipeline", "AllowedQuoteType", "ApiAccess", "Application", "Appointment", "AppointmentClientInviteesRelation", "AppointmentContactInviteesRelation", "AppointmentInviteeNotifyQueue", "AppointmentReminder", "AppointmentSchedule", "AppointmentType", "Approval", "ApprovalApprover", "ApprovalProcess", "ApprovalProcessActivityLogLine", "AuditLog", "AutomationHubApp", "AutomationHubCategory", "AutomationHubItem", "ChatConversation", "Client", "ClientExcludedOppty", "ClientFavorite", "ClientSetting", "ClientStoryRead", "CloudObject", "CloudObjectFolder", "CloudObjectRelation", "CloudObjectStepRelation", "CloudObjectTemplate", "CompanyEmail", "Contact", "ContactAccountAccountRoleRelation", "ContactAccountRelation", "ContactDataExRelation", "ContactKPI", "ContactRelation", "ContactRelationType", "ContactSharingClientRelation", "ContactSharingSalesUnitRelation", "ContactSocialRelation", "ContactType", "Country", "CountryCrm", "CpActivity", "CpCallLog", "CpCalling", "CpClient", "CpProduct", "CpProfile", "CpTeamSpaceClient", "Currency", "CurrencyExchangeRate", "CurrencyExchangeRatesList", "CustomEntity", "CustomEntityDataExRelation", "CustomEntityKPI", "CustomEntityRelation", "CustomEntityRelationData", "CustomEntitySharingClientRelation", "CustomEntitySharingSalesUnitRelation", "CustomEntityType", "Data", "Ebook", "Email", "EmailContentSharingClientRelation", "EmailContentSharingSalesUnitRelation", "EmailMailboxRelation", "EmailSequence", "EmailSequenceActivityLog", "EmailSequenceActivityLogLine", "EmailSequenceEnrolled", "EmailSequenceEnrolledStatus", "EmailSequenceSettings", "EmailTemplate", "EmailTemplateFolder", "EmailTemplateSharingClientRelation", "EmailTemplateSharingSalesUnitRelation", "EmailThreadMailboxClientReadState", "Entity", "EntityFitness", "EntityFitnessIndicator", "EntityHealth", "EntityHealthSettingsHistory", "EntityScoring", "EntitySettings", "EntityType", "Field", "FieldMapping", "FieldPermission", "FieldSequence", "Forecast", "ForecastSharingClientRelation", "ForecastSharingSalesUnitRelation", "FormView", "FormViewSharingClientRelation", "FormViewSharingSalesUnitRelation", "GhostContact", "GhostContactAccountAccountRoleRelation", "GhostContactAccountRelation", "GhostLeadOpptyContactRelation", "GhostLeadOpptyContactSalesRoleRelation", "HowTo", "ImportMappingMask", "InterfacePreview", "Lead", "LeadOppty", "LeadOpptyAccountRelation", "LeadOpptyContactGroupRelation", "LeadOpptyContactRelation", "LeadOpptyContactSalesRoleRelation", "LeadOpptyDataExRelation", "LeadOpptyKPI", "LeadOpptyProjectRelation", "LeadOpptySharingClientRelation", "LeadOpptySharingSalesUnitRelation", "LeadOpptyStepCheckListRelation", "LeadOpptyType", "LeadProcess", "LeadType", "MasterRight", "Media", "Memo", "MemoComment", "Message", "MessageRelation", "MessageSharingClientRelation", "MessageSharingSalesUnitRelation", "Note", "NotificationSetting", "OnlineForm", "OnlineFormActivityLogLine", "OnlineFormDataExRelation", "OnlineFormRelation", "OnlineFormStyle", "OnlineFormType", "OnlineFormTypeEmailRelation", "Opportunity", "OpportunityType", "OpptyProductRelation", "OpptyProductRelationDataExRelation", "OpptyProductRelationRevenueSchedule", "OpptyProductRelationRevenueSchedulePeriod", "OpptyProductRelationType", "OpptyRecurrence", "OpptyRevenueSchedule", "OpptyRevenueSchedulePeriod", "Order", "OrderHistory", "OrderItem", "OrderRelatedDocument", "OrderTempData", "OrderTempDataItem", "ParentAccountRelationType", "Partner", "Payment", "PaymentAdditionalData", "PaymentTerm", "Phone", "Pipeline", "Process", "ProcessActivityLog", "ProcessActivityLogLine", "ProcessChangeOwnerLog", "ProcessScheduledAction", "ProcessTemplate", "Product", "ProductCategory", "ProductDataExRelation", "ProductPipelineRelation", "ProductPriceList", "ProductPriceListPrice", "ProductType", "Profile", "ProfileDraft", "ProfileRelation", "ProfileSharingClientRelation", "ProfileSharingSalesUnitRelation", "Project", "ProjectContactRelation", "ProjectDataExRelation", "ProjectKPI", "ProjectObjective", "ProjectSharingClientRelation", "ProjectSharingSalesUnitRelation", "ProjectType", "PurchasedProduct", "Quote", "QuoteAccountRelation", "QuoteContactRelation", "QuoteDataExRelation", "QuoteKPI", "QuoteProcess", "QuoteSharingClientRelation", "QuoteSharingSalesUnitRelation", "QuoteType", "ReleaseNote", "Report", "ReportFolder", "ReportSchedule", "ReportSharingClientRelation", "ReportSharingSalesUnitRelation", "RevenueRecognition", "SalesRole", "SalesUnit", "SalesUnitClientRelation", "SapiUser", "SpaceSetting", "State", "Step", "StepChecklist", "StepChecklistSalesRoleRelation", "Storylane", "Subscription", "SubscriptionHubItem", "SubscriptionNotification", "SubscriptionRepresentative", "SubscriptionSDR", "Supplier", "Tag", "TagRelation", "Target", "TargetRelation", "Task", "TaskRecurrence", "TaskReminder", "TaskSharingClientRelation", "TaskSharingSalesUnitRelation", "TaskType", "TeamPipelineHubItem", "TeamPipelineHubItemBase", "TeamSpace", "TeamSpaceClient", "TeamSpaceClientSetting", "TeamSpaceProperty", "TeamSpaceRegion", "TextMessage", "TextMessageConversation", "TextMessageConversationRelations", "Timeframe", "Translation", "Type", "UnsubscribedPhone", "UseCase", "UserProfile", "UserRole", "Webhook", "WebhookEvent", "Webresource"], "description": "Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is \"CustomEntity\" and the API name is exposed via template_entity_api_name."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: -1 - S3FileUpload, 1 - S3File, 2 - S3Image, 3 - GoogleDriveFile, 4 - OneDriveFile, 5 - BoxFile, 6 - DropboxFile, 7 - SharepointFile, 8 - ExternalURL, 9 - AlfrescoFile, 10 - UrlFile", "example": -1, "enum": [-1, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10], "readOnly": true}, "upload_source": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - EmailTemplate, 2 - RichTextEditor", "example": 1, "enum": [1, 2]}, "url": {"type": "string", "example": "string", "description": "URL of the object. If URL scheme is not defined \"http://\" is automatically prepended to supplied URL.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "content": {"type": "string", "format": "binary", "example": "blob", "description": "Data content of the object."}, "template_entity_api_name": {"type": "string", "example": "string", "description": "API name of the custom entity the template renders. Set only when template_entity_name is \"CustomEntity\"; otherwise empty."}}, "required": ["filename", "template_entity_name", "type"]}, "updateCloudObjectTemplateInput": {"properties": {"application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the producing application."}, "company_cloud_object_folder_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the company folder, or empty when the object is not stored in the company tree."}, "creator_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the uploading user."}, "filename": {"type": "string", "example": "string", "description": "File name (with extension) used when downloading the object."}, "is_public": {"type": "boolean", "example": false, "description": "When true, the object can be served via a public URL (see public_url)."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Active, 2 - Inactive", "example": 1, "enum": [1, 2]}, "template_entity_name": {"type": "string", "example": "Account", "enum": ["Account", "AccountDataExRelation", "AccountKPI", "AccountProductPricing", "AccountRole", "AccountSharingClientRelation", "AccountSharingSalesUnitRelation", "AccountSocialRelation", "AccountType", "Activity", "ActivityComment", "ActivityDataExRelation", "ActivityDetail", "ActivityKPI", "ActivityRelation", "ActivityType", "AiAgent", "AiBalance", "AiEvent", "AiEventJournal", "AllowedAccountType", "AllowedCompanyPhone", "AllowedContactType", "AllowedLeadType", "AllowedPipeline", "AllowedQuoteType", "ApiAccess", "Application", "Appointment", "AppointmentClientInviteesRelation", "AppointmentContactInviteesRelation", "AppointmentInviteeNotifyQueue", "AppointmentReminder", "AppointmentSchedule", "AppointmentType", "Approval", "ApprovalApprover", "ApprovalProcess", "ApprovalProcessActivityLogLine", "AuditLog", "AutomationHubApp", "AutomationHubCategory", "AutomationHubItem", "ChatConversation", "Client", "ClientExcludedOppty", "ClientFavorite", "ClientSetting", "ClientStoryRead", "CloudObject", "CloudObjectFolder", "CloudObjectRelation", "CloudObjectStepRelation", "CloudObjectTemplate", "CompanyEmail", "Contact", "ContactAccountAccountRoleRelation", "ContactAccountRelation", "ContactDataExRelation", "ContactKPI", "ContactRelation", "ContactRelationType", "ContactSharingClientRelation", "ContactSharingSalesUnitRelation", "ContactSocialRelation", "ContactType", "Country", "CountryCrm", "CpActivity", "CpCallLog", "CpCalling", "CpClient", "CpProduct", "CpProfile", "CpTeamSpaceClient", "Currency", "CurrencyExchangeRate", "CurrencyExchangeRatesList", "CustomEntity", "CustomEntityDataExRelation", "CustomEntityKPI", "CustomEntityRelation", "CustomEntityRelationData", "CustomEntitySharingClientRelation", "CustomEntitySharingSalesUnitRelation", "CustomEntityType", "Data", "Ebook", "Email", "EmailContentSharingClientRelation", "EmailContentSharingSalesUnitRelation", "EmailMailboxRelation", "EmailSequence", "EmailSequenceActivityLog", "EmailSequenceActivityLogLine", "EmailSequenceEnrolled", "EmailSequenceEnrolledStatus", "EmailSequenceSettings", "EmailTemplate", "EmailTemplateFolder", "EmailTemplateSharingClientRelation", "EmailTemplateSharingSalesUnitRelation", "EmailThreadMailboxClientReadState", "Entity", "EntityFitness", "EntityFitnessIndicator", "EntityHealth", "EntityHealthSettingsHistory", "EntityScoring", "EntitySettings", "EntityType", "Field", "FieldMapping", "FieldPermission", "FieldSequence", "Forecast", "ForecastSharingClientRelation", "ForecastSharingSalesUnitRelation", "FormView", "FormViewSharingClientRelation", "FormViewSharingSalesUnitRelation", "GhostContact", "GhostContactAccountAccountRoleRelation", "GhostContactAccountRelation", "GhostLeadOpptyContactRelation", "GhostLeadOpptyContactSalesRoleRelation", "HowTo", "ImportMappingMask", "InterfacePreview", "Lead", "LeadOppty", "LeadOpptyAccountRelation", "LeadOpptyContactGroupRelation", "LeadOpptyContactRelation", "LeadOpptyContactSalesRoleRelation", "LeadOpptyDataExRelation", "LeadOpptyKPI", "LeadOpptyProjectRelation", "LeadOpptySharingClientRelation", "LeadOpptySharingSalesUnitRelation", "LeadOpptyStepCheckListRelation", "LeadOpptyType", "LeadProcess", "LeadType", "MasterRight", "Media", "Memo", "MemoComment", "Message", "MessageRelation", "MessageSharingClientRelation", "MessageSharingSalesUnitRelation", "Note", "NotificationSetting", "OnlineForm", "OnlineFormActivityLogLine", "OnlineFormDataExRelation", "OnlineFormRelation", "OnlineFormStyle", "OnlineFormType", "OnlineFormTypeEmailRelation", "Opportunity", "OpportunityType", "OpptyProductRelation", "OpptyProductRelationDataExRelation", "OpptyProductRelationRevenueSchedule", "OpptyProductRelationRevenueSchedulePeriod", "OpptyProductRelationType", "OpptyRecurrence", "OpptyRevenueSchedule", "OpptyRevenueSchedulePeriod", "Order", "OrderHistory", "OrderItem", "OrderRelatedDocument", "OrderTempData", "OrderTempDataItem", "ParentAccountRelationType", "Partner", "Payment", "PaymentAdditionalData", "PaymentTerm", "Phone", "Pipeline", "Process", "ProcessActivityLog", "ProcessActivityLogLine", "ProcessChangeOwnerLog", "ProcessScheduledAction", "ProcessTemplate", "Product", "ProductCategory", "ProductDataExRelation", "ProductPipelineRelation", "ProductPriceList", "ProductPriceListPrice", "ProductType", "Profile", "ProfileDraft", "ProfileRelation", "ProfileSharingClientRelation", "ProfileSharingSalesUnitRelation", "Project", "ProjectContactRelation", "ProjectDataExRelation", "ProjectKPI", "ProjectObjective", "ProjectSharingClientRelation", "ProjectSharingSalesUnitRelation", "ProjectType", "PurchasedProduct", "Quote", "QuoteAccountRelation", "QuoteContactRelation", "QuoteDataExRelation", "QuoteKPI", "QuoteProcess", "QuoteSharingClientRelation", "QuoteSharingSalesUnitRelation", "QuoteType", "ReleaseNote", "Report", "ReportFolder", "ReportSchedule", "ReportSharingClientRelation", "ReportSharingSalesUnitRelation", "RevenueRecognition", "SalesRole", "SalesUnit", "SalesUnitClientRelation", "SapiUser", "SpaceSetting", "State", "Step", "StepChecklist", "StepChecklistSalesRoleRelation", "Storylane", "Subscription", "SubscriptionHubItem", "SubscriptionNotification", "SubscriptionRepresentative", "SubscriptionSDR", "Supplier", "Tag", "TagRelation", "Target", "TargetRelation", "Task", "TaskRecurrence", "TaskReminder", "TaskSharingClientRelation", "TaskSharingSalesUnitRelation", "TaskType", "TeamPipelineHubItem", "TeamPipelineHubItemBase", "TeamSpace", "TeamSpaceClient", "TeamSpaceClientSetting", "TeamSpaceProperty", "TeamSpaceRegion", "TextMessage", "TextMessageConversation", "TextMessageConversationRelations", "Timeframe", "Translation", "Type", "UnsubscribedPhone", "UseCase", "UserProfile", "UserRole", "Webhook", "WebhookEvent", "Webresource"], "description": "Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is \"CustomEntity\" and the API name is exposed via template_entity_api_name."}, "upload_source": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - EmailTemplate, 2 - RichTextEditor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "content": {"type": "string", "format": "binary", "example": "blob", "description": "Data content of the object."}, "template_entity_api_name": {"type": "string", "example": "string", "description": "API name of the custom entity the template renders. Set only when template_entity_name is \"CustomEntity\"; otherwise empty."}}}, "batchCloudObjectTemplateInput": {"properties": {"application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the producing application."}, "company_cloud_object_folder_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the company folder, or empty when the object is not stored in the company tree."}, "creator_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the uploading user."}, "filename": {"type": "string", "example": "string", "description": "File name (with extension) used when downloading the object."}, "is_public": {"type": "boolean", "example": false, "description": "When true, the object can be served via a public URL (see public_url)."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Active, 2 - Inactive", "example": 1, "enum": [1, 2]}, "template_entity_name": {"type": "string", "example": "Account", "enum": ["Account", "AccountDataExRelation", "AccountKPI", "AccountProductPricing", "AccountRole", "AccountSharingClientRelation", "AccountSharingSalesUnitRelation", "AccountSocialRelation", "AccountType", "Activity", "ActivityComment", "ActivityDataExRelation", "ActivityDetail", "ActivityKPI", "ActivityRelation", "ActivityType", "AiAgent", "AiBalance", "AiEvent", "AiEventJournal", "AllowedAccountType", "AllowedCompanyPhone", "AllowedContactType", "AllowedLeadType", "AllowedPipeline", "AllowedQuoteType", "ApiAccess", "Application", "Appointment", "AppointmentClientInviteesRelation", "AppointmentContactInviteesRelation", "AppointmentInviteeNotifyQueue", "AppointmentReminder", "AppointmentSchedule", "AppointmentType", "Approval", "ApprovalApprover", "ApprovalProcess", "ApprovalProcessActivityLogLine", "AuditLog", "AutomationHubApp", "AutomationHubCategory", "AutomationHubItem", "ChatConversation", "Client", "ClientExcludedOppty", "ClientFavorite", "ClientSetting", "ClientStoryRead", "CloudObject", "CloudObjectFolder", "CloudObjectRelation", "CloudObjectStepRelation", "CloudObjectTemplate", "CompanyEmail", "Contact", "ContactAccountAccountRoleRelation", "ContactAccountRelation", "ContactDataExRelation", "ContactKPI", "ContactRelation", "ContactRelationType", "ContactSharingClientRelation", "ContactSharingSalesUnitRelation", "ContactSocialRelation", "ContactType", "Country", "CountryCrm", "CpActivity", "CpCallLog", "CpCalling", "CpClient", "CpProduct", "CpProfile", "CpTeamSpaceClient", "Currency", "CurrencyExchangeRate", "CurrencyExchangeRatesList", "CustomEntity", "CustomEntityDataExRelation", "CustomEntityKPI", "CustomEntityRelation", "CustomEntityRelationData", "CustomEntitySharingClientRelation", "CustomEntitySharingSalesUnitRelation", "CustomEntityType", "Data", "Ebook", "Email", "EmailContentSharingClientRelation", "EmailContentSharingSalesUnitRelation", "EmailMailboxRelation", "EmailSequence", "EmailSequenceActivityLog", "EmailSequenceActivityLogLine", "EmailSequenceEnrolled", "EmailSequenceEnrolledStatus", "EmailSequenceSettings", "EmailTemplate", "EmailTemplateFolder", "EmailTemplateSharingClientRelation", "EmailTemplateSharingSalesUnitRelation", "EmailThreadMailboxClientReadState", "Entity", "EntityFitness", "EntityFitnessIndicator", "EntityHealth", "EntityHealthSettingsHistory", "EntityScoring", "EntitySettings", "EntityType", "Field", "FieldMapping", "FieldPermission", "FieldSequence", "Forecast", "ForecastSharingClientRelation", "ForecastSharingSalesUnitRelation", "FormView", "FormViewSharingClientRelation", "FormViewSharingSalesUnitRelation", "GhostContact", "GhostContactAccountAccountRoleRelation", "GhostContactAccountRelation", "GhostLeadOpptyContactRelation", "GhostLeadOpptyContactSalesRoleRelation", "HowTo", "ImportMappingMask", "InterfacePreview", "Lead", "LeadOppty", "LeadOpptyAccountRelation", "LeadOpptyContactGroupRelation", "LeadOpptyContactRelation", "LeadOpptyContactSalesRoleRelation", "LeadOpptyDataExRelation", "LeadOpptyKPI", "LeadOpptyProjectRelation", "LeadOpptySharingClientRelation", "LeadOpptySharingSalesUnitRelation", "LeadOpptyStepCheckListRelation", "LeadOpptyType", "LeadProcess", "LeadType", "MasterRight", "Media", "Memo", "MemoComment", "Message", "MessageRelation", "MessageSharingClientRelation", "MessageSharingSalesUnitRelation", "Note", "NotificationSetting", "OnlineForm", "OnlineFormActivityLogLine", "OnlineFormDataExRelation", "OnlineFormRelation", "OnlineFormStyle", "OnlineFormType", "OnlineFormTypeEmailRelation", "Opportunity", "OpportunityType", "OpptyProductRelation", "OpptyProductRelationDataExRelation", "OpptyProductRelationRevenueSchedule", "OpptyProductRelationRevenueSchedulePeriod", "OpptyProductRelationType", "OpptyRecurrence", "OpptyRevenueSchedule", "OpptyRevenueSchedulePeriod", "Order", "OrderHistory", "OrderItem", "OrderRelatedDocument", "OrderTempData", "OrderTempDataItem", "ParentAccountRelationType", "Partner", "Payment", "PaymentAdditionalData", "PaymentTerm", "Phone", "Pipeline", "Process", "ProcessActivityLog", "ProcessActivityLogLine", "ProcessChangeOwnerLog", "ProcessScheduledAction", "ProcessTemplate", "Product", "ProductCategory", "ProductDataExRelation", "ProductPipelineRelation", "ProductPriceList", "ProductPriceListPrice", "ProductType", "Profile", "ProfileDraft", "ProfileRelation", "ProfileSharingClientRelation", "ProfileSharingSalesUnitRelation", "Project", "ProjectContactRelation", "ProjectDataExRelation", "ProjectKPI", "ProjectObjective", "ProjectSharingClientRelation", "ProjectSharingSalesUnitRelation", "ProjectType", "PurchasedProduct", "Quote", "QuoteAccountRelation", "QuoteContactRelation", "QuoteDataExRelation", "QuoteKPI", "QuoteProcess", "QuoteSharingClientRelation", "QuoteSharingSalesUnitRelation", "QuoteType", "ReleaseNote", "Report", "ReportFolder", "ReportSchedule", "ReportSharingClientRelation", "ReportSharingSalesUnitRelation", "RevenueRecognition", "SalesRole", "SalesUnit", "SalesUnitClientRelation", "SapiUser", "SpaceSetting", "State", "Step", "StepChecklist", "StepChecklistSalesRoleRelation", "Storylane", "Subscription", "SubscriptionHubItem", "SubscriptionNotification", "SubscriptionRepresentative", "SubscriptionSDR", "Supplier", "Tag", "TagRelation", "Target", "TargetRelation", "Task", "TaskRecurrence", "TaskReminder", "TaskSharingClientRelation", "TaskSharingSalesUnitRelation", "TaskType", "TeamPipelineHubItem", "TeamPipelineHubItemBase", "TeamSpace", "TeamSpaceClient", "TeamSpaceClientSetting", "TeamSpaceProperty", "TeamSpaceRegion", "TextMessage", "TextMessageConversation", "TextMessageConversationRelations", "Timeframe", "Translation", "Type", "UnsubscribedPhone", "UseCase", "UserProfile", "UserRole", "Webhook", "WebhookEvent", "Webresource"], "description": "Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is \"CustomEntity\" and the API name is exposed via template_entity_api_name."}, "upload_source": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - EmailTemplate, 2 - RichTextEditor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "content": {"type": "string", "format": "binary", "example": "blob", "description": "Data content of the object."}, "template_entity_api_name": {"type": "string", "example": "string", "description": "API name of the custom entity the template renders. Set only when template_entity_name is \"CustomEntity\"; otherwise empty."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "CompanyEmail": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "email": {"type": "string", "example": "string", "description": "Email address of the company mailbox (the From address)."}, "enabled": {"type": "boolean", "example": false, "description": "False when the mailbox is disabled (either by the user or because the underlying feature is not available); true otherwise."}, "error_code": {"type": "integer", "format": "int32", "example": 1, "description": "Error code recorded for the mailbox; empty when healthy. Set on integration failures or when the user disables the integration."}, "name": {"type": "string", "example": "string", "description": "Display name of the company email account, shown in the UI."}, "picture_url": {"type": "string", "example": "string", "description": "URL of the avatar image used as the sender picture for emails sent from this account."}, "service_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - O365Email, 2 - GoogleEmail, 3 - SendGrid", "example": 1, "enum": [1, 2, 3]}, "settings": {"type": "object", "description": "Provider-specific configuration for the mailbox (e.g. parse_subdomain for SendGrid)."}, "token": {"type": "string", "format": "binary", "example": "blob", "description": "OAuth/secret credentials for the mailbox. Read-only and only returned to service-to-service callers; setting via the public API is not supported."}, "features": {"type": "array", "items": {"type": "integer", "description": "Integer enum value: 1 - CanSyncBounces, 2 - CanSyncIncoming", "example": 1, "enum": [1, 2]}, "description": "List of capabilities supported by the underlying email service (e.g. CanSyncBounces, CanSyncIncoming)."}, "mailbox_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Stable UUID derived from the mailbox address and service type, used to correlate the company email account with its integration settings entry."}}, "required": ["is_delete_protected", "id", "enabled", "name", "service_type", "features"]}, "Contact": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time."}, "contact_type": {"type": "string", "format": "uri", "description": "Contact type that classifies this contact. Contact types are configurable per team space and drive which form, fields and pipelines apply.\n\nRelation to ContactType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactType' object for properties."}, "currency_exchange_rates_list": {"type": "string", "format": "uri", "description": "Currency exchange rate list used to convert monetary fields linked to this contact. Empty to inherit the team space default.\n\nRelation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRatesList' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "Sales user who owns this contact.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "picture": {"type": "string", "format": "uri", "description": "Profile picture associated with the contact.\n\nRelation to CloudObject. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObject' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit this contact is assigned to. Determines which team members can see the record under unit-based sharing.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "address": {"type": "string", "example": "string", "description": "Street address of the contact."}, "city": {"type": "string", "example": "string", "description": "City of the contact address."}, "comments": {"type": "string", "example": "string", "description": "Free-form notes describing the contact."}, "contact_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact type assigned to this contact."}, "country": {"type": "string", "example": "string", "description": "Country of the contact address."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this contact."}, "email1": {"type": "string", "example": "string", "description": "Primary email address of the contact. Used as default recipient for emails sent from Coevera."}, "email2": {"type": "string", "example": "string", "description": "Additional email address."}, "email3": {"type": "string", "example": "string", "description": "Additional email address."}, "email4": {"type": "string", "example": "string", "description": "Additional email address."}, "email5": {"type": "string", "example": "string", "description": "Additional email address."}, "first_name": {"type": "string", "example": "string", "description": "Given name of the contact."}, "gender": {"type": "integer", "description": "Gender of the contact (e.g. Male, Female, Other).\n\nInteger enum value: 0 - Unknown, 1 - Male, 2 - Female, 3 - NonBinary", "example": 0, "enum": [0, 1, 2, 3]}, "is_archived": {"type": "boolean", "example": false, "description": "True when the contact has been archived. Archived contacts remain readable but are hidden from active lists and cannot be edited until reactivated."}, "last_name": {"type": "string", "example": "string", "description": "Family name of the contact."}, "middle_name": {"type": "string", "example": "string", "description": "Middle name of the contact, if applicable."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact owner."}, "phone1": {"type": "string", "example": "string", "description": "Primary phone number of the contact. Used as default target for click-to-call."}, "phone2": {"type": "string", "example": "string", "description": "Additional phone number."}, "phone3": {"type": "string", "example": "string", "description": "Additional phone number."}, "phone4": {"type": "string", "example": "string", "description": "Additional phone number."}, "phone5": {"type": "string", "example": "string", "description": "Additional phone number."}, "picture_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the profile picture document."}, "position": {"type": "string", "example": "string", "description": "Job title or position of the contact."}, "quick_account_name": {"type": "string", "example": "string", "description": "Free-text company name used when the contact is not linked to an actual Account record. Lets integrators capture the company without creating a separate Account."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "state_province": {"type": "string", "example": "string", "description": "State or province of the contact address."}, "title": {"type": "string", "example": "string", "description": "Honorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "zip_code": {"type": "string", "example": "string", "description": "ZIP or postal code of the contact address."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "formatted_name": {"type": "string", "example": "string", "description": "Display version of the contact name (title, first, middle, last). Used in lists and references."}, "social_media": {"type": "string", "format": "uri", "description": "Social network profiles linked to this contact (e.g. LinkedIn, Facebook).\n\nRelation to ContactSocialRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactSocialRelation' object for properties."}, "primary_account": {"type": "string", "format": "uri", "description": "Primary account this contact belongs to. Set automatically when the contact has an account relation marked as primary.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "account_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ContactAccountRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactAccountRelation' object for properties."}, "description": "Accounts this contact is linked to. Each link records the role and position the contact has at the related account."}, "sharing_units": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ContactSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactSharingSalesUnitRelation' object for properties."}, "description": "Sales units that have been granted shared access to this contact. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ContactSharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactSharingClientRelation' object for properties."}, "description": "Users that have been granted shared access to this contact. Editable only when share_mode allows user sharing."}, "documents": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties."}, "description": "Documents linked to this contact."}, "exchange_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "gapi_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "o365_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "is_favorite": {"type": "boolean", "example": false, "description": "True when the current authenticated user has marked this contact as favorite. Per-user."}, "primary_account_account_roles": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ContactAccountAccountRoleRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactAccountAccountRoleRelation' object for properties."}, "description": "Roles of Contact in his primary Account."}, "primary_account_position": {"type": "string", "example": "string", "description": "Job position of Contact in his primary Account."}, "account_position": {"type": "string", "example": "string", "description": "Job position of Contact in his primary Account or quick account position if Contact has no primary Account."}, "is_unsubscribed": {"type": "boolean", "example": false, "description": "If account has any unsubscribed email."}, "tags": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to TagRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TagRelation' object for properties."}, "description": "Tag labels applied to this contact."}, "static_profiles": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ProfileRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProfileRelation' object for properties."}, "description": "Saved view profiles this contact currently matches."}, "primary_account_relationship": {"type": "string", "example": "string", "description": "Org chart relationship of Contact in his primary Account."}, "modified_by_user": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera."}}, "required": ["is_delete_protected", "id", "contact_type", "owner", "unit", "owner_id", "formatted_name", "is_favorite"]}, "createContactInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time."}, "picture": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Profile picture associated with the contact.\n\nRelation to CloudObject, see: 'createCloudObjectInput' object for properties."}, "address": {"type": "string", "example": "string", "description": "Street address of the contact."}, "city": {"type": "string", "example": "string", "description": "City of the contact address."}, "comments": {"type": "string", "example": "string", "description": "Free-form notes describing the contact."}, "contact_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact type assigned to this contact."}, "country": {"type": "string", "example": "string", "description": "Country of the contact address."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this contact."}, "email1": {"type": "string", "example": "string", "description": "Primary email address of the contact. Used as default recipient for emails sent from Coevera."}, "email2": {"type": "string", "example": "string", "description": "Additional email address."}, "email3": {"type": "string", "example": "string", "description": "Additional email address."}, "email4": {"type": "string", "example": "string", "description": "Additional email address."}, "email5": {"type": "string", "example": "string", "description": "Additional email address."}, "first_name": {"type": "string", "example": "string", "description": "Given name of the contact."}, "gender": {"type": "integer", "description": "Gender of the contact (e.g. Male, Female, Other).\n\nInteger enum value: 0 - Unknown, 1 - Male, 2 - Female, 3 - NonBinary", "example": 0, "enum": [0, 1, 2, 3]}, "is_archived": {"type": "boolean", "example": false, "description": "True when the contact has been archived. Archived contacts remain readable but are hidden from active lists and cannot be edited until reactivated."}, "last_name": {"type": "string", "example": "string", "description": "Family name of the contact."}, "middle_name": {"type": "string", "example": "string", "description": "Middle name of the contact, if applicable."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact owner."}, "phone1": {"type": "string", "example": "string", "description": "Primary phone number of the contact. Used as default target for click-to-call."}, "phone2": {"type": "string", "example": "string", "description": "Additional phone number."}, "phone3": {"type": "string", "example": "string", "description": "Additional phone number."}, "phone4": {"type": "string", "example": "string", "description": "Additional phone number."}, "phone5": {"type": "string", "example": "string", "description": "Additional phone number."}, "picture_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the profile picture document."}, "position": {"type": "string", "example": "string", "description": "Job title or position of the contact."}, "quick_account_name": {"type": "string", "example": "string", "description": "Free-text company name used when the contact is not linked to an actual Account record. Lets integrators capture the company without creating a separate Account."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "state_province": {"type": "string", "example": "string", "description": "State or province of the contact address."}, "title": {"type": "string", "example": "string", "description": "Honorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "zip_code": {"type": "string", "example": "string", "description": "ZIP or postal code of the contact address."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "social_media": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Social network profiles linked to this contact (e.g. LinkedIn, Facebook).\n\nRelation to ContactSocialRelation, see: 'createContactSocialRelationInput' object for properties."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ContactAccountRelation, see: 'createContactAccountRelationInput' object for properties."}, "description": "Accounts this contact is linked to. Each link records the role and position the contact has at the related account."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ContactSharingSalesUnitRelation, see: 'createContactSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this contact. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ContactSharingClientRelation, see: 'createContactSharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this contact. Editable only when share_mode allows user sharing."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this contact."}, "primary_account_account_roles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ContactAccountAccountRoleRelation, see: 'createContactAccountAccountRoleRelationInput' object for properties."}, "description": "Roles of Contact in his primary Account."}, "account_position": {"type": "string", "example": "string", "description": "Job position of Contact in his primary Account or quick account position if Contact has no primary Account."}, "is_unsubscribed": {"type": "boolean", "example": false, "description": "If account has any unsubscribed email."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'createTagRelationInput' object for properties."}, "description": "Tag labels applied to this contact."}, "static_profiles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProfileRelation, see: 'createProfileRelationInput' object for properties."}, "description": "Saved view profiles this contact currently matches."}, "primary_account_relationship": {"type": "string", "example": "string", "description": "Org chart relationship of Contact in his primary Account."}}, "required": ["owner_id"]}, "updateContactInput": {"properties": {"created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time."}, "picture": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Profile picture associated with the contact.\n\nRelation to CloudObject, see: 'updateCloudObjectInput' object for properties."}, "address": {"type": "string", "example": "string", "description": "Street address of the contact."}, "city": {"type": "string", "example": "string", "description": "City of the contact address."}, "comments": {"type": "string", "example": "string", "description": "Free-form notes describing the contact."}, "contact_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact type assigned to this contact."}, "country": {"type": "string", "example": "string", "description": "Country of the contact address."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this contact."}, "email1": {"type": "string", "example": "string", "description": "Primary email address of the contact. Used as default recipient for emails sent from Coevera."}, "email2": {"type": "string", "example": "string", "description": "Additional email address."}, "email3": {"type": "string", "example": "string", "description": "Additional email address."}, "email4": {"type": "string", "example": "string", "description": "Additional email address."}, "email5": {"type": "string", "example": "string", "description": "Additional email address."}, "first_name": {"type": "string", "example": "string", "description": "Given name of the contact."}, "gender": {"type": "integer", "description": "Gender of the contact (e.g. Male, Female, Other).\n\nInteger enum value: 0 - Unknown, 1 - Male, 2 - Female, 3 - NonBinary", "example": 0, "enum": [0, 1, 2, 3]}, "is_archived": {"type": "boolean", "example": false, "description": "True when the contact has been archived. Archived contacts remain readable but are hidden from active lists and cannot be edited until reactivated."}, "last_name": {"type": "string", "example": "string", "description": "Family name of the contact."}, "middle_name": {"type": "string", "example": "string", "description": "Middle name of the contact, if applicable."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact owner."}, "phone1": {"type": "string", "example": "string", "description": "Primary phone number of the contact. Used as default target for click-to-call."}, "phone2": {"type": "string", "example": "string", "description": "Additional phone number."}, "phone3": {"type": "string", "example": "string", "description": "Additional phone number."}, "phone4": {"type": "string", "example": "string", "description": "Additional phone number."}, "phone5": {"type": "string", "example": "string", "description": "Additional phone number."}, "picture_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the profile picture document."}, "position": {"type": "string", "example": "string", "description": "Job title or position of the contact."}, "quick_account_name": {"type": "string", "example": "string", "description": "Free-text company name used when the contact is not linked to an actual Account record. Lets integrators capture the company without creating a separate Account."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "state_province": {"type": "string", "example": "string", "description": "State or province of the contact address."}, "title": {"type": "string", "example": "string", "description": "Honorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "zip_code": {"type": "string", "example": "string", "description": "ZIP or postal code of the contact address."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "social_media": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Social network profiles linked to this contact (e.g. LinkedIn, Facebook).\n\nRelation to ContactSocialRelation, see: 'updateContactSocialRelationInput' object for properties."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ContactAccountRelation, see: 'updateContactAccountRelationInput' object for properties."}, "description": "Accounts this contact is linked to. Each link records the role and position the contact has at the related account."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ContactSharingSalesUnitRelation, see: 'updateContactSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this contact. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ContactSharingClientRelation, see: 'updateContactSharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this contact. Editable only when share_mode allows user sharing."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this contact."}, "exchange_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "gapi_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "o365_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "primary_account_account_roles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ContactAccountAccountRoleRelation, see: 'updateContactAccountAccountRoleRelationInput' object for properties."}, "description": "Roles of Contact in his primary Account."}, "account_position": {"type": "string", "example": "string", "description": "Job position of Contact in his primary Account or quick account position if Contact has no primary Account."}, "is_unsubscribed": {"type": "boolean", "example": false, "description": "If account has any unsubscribed email."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'updateTagRelationInput' object for properties."}, "description": "Tag labels applied to this contact."}, "static_profiles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProfileRelation, see: 'updateProfileRelationInput' object for properties."}, "description": "Saved view profiles this contact currently matches."}, "primary_account_relationship": {"type": "string", "example": "string", "description": "Org chart relationship of Contact in his primary Account."}}}, "batchContactInput": {"properties": {"created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time."}, "picture": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Profile picture associated with the contact.\n\nRelation to CloudObject, see: 'updateCloudObjectInput' object for properties."}, "address": {"type": "string", "example": "string", "description": "Street address of the contact."}, "city": {"type": "string", "example": "string", "description": "City of the contact address."}, "comments": {"type": "string", "example": "string", "description": "Free-form notes describing the contact."}, "contact_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact type assigned to this contact."}, "country": {"type": "string", "example": "string", "description": "Country of the contact address."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this contact."}, "email1": {"type": "string", "example": "string", "description": "Primary email address of the contact. Used as default recipient for emails sent from Coevera."}, "email2": {"type": "string", "example": "string", "description": "Additional email address."}, "email3": {"type": "string", "example": "string", "description": "Additional email address."}, "email4": {"type": "string", "example": "string", "description": "Additional email address."}, "email5": {"type": "string", "example": "string", "description": "Additional email address."}, "first_name": {"type": "string", "example": "string", "description": "Given name of the contact."}, "gender": {"type": "integer", "description": "Gender of the contact (e.g. Male, Female, Other).\n\nInteger enum value: 0 - Unknown, 1 - Male, 2 - Female, 3 - NonBinary", "example": 0, "enum": [0, 1, 2, 3]}, "is_archived": {"type": "boolean", "example": false, "description": "True when the contact has been archived. Archived contacts remain readable but are hidden from active lists and cannot be edited until reactivated."}, "last_name": {"type": "string", "example": "string", "description": "Family name of the contact."}, "middle_name": {"type": "string", "example": "string", "description": "Middle name of the contact, if applicable."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact owner."}, "phone1": {"type": "string", "example": "string", "description": "Primary phone number of the contact. Used as default target for click-to-call."}, "phone2": {"type": "string", "example": "string", "description": "Additional phone number."}, "phone3": {"type": "string", "example": "string", "description": "Additional phone number."}, "phone4": {"type": "string", "example": "string", "description": "Additional phone number."}, "phone5": {"type": "string", "example": "string", "description": "Additional phone number."}, "picture_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the profile picture document."}, "position": {"type": "string", "example": "string", "description": "Job title or position of the contact."}, "quick_account_name": {"type": "string", "example": "string", "description": "Free-text company name used when the contact is not linked to an actual Account record. Lets integrators capture the company without creating a separate Account."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "state_province": {"type": "string", "example": "string", "description": "State or province of the contact address."}, "title": {"type": "string", "example": "string", "description": "Honorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "zip_code": {"type": "string", "example": "string", "description": "ZIP or postal code of the contact address."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "social_media": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Social network profiles linked to this contact (e.g. LinkedIn, Facebook).\n\nRelation to ContactSocialRelation, see: 'updateContactSocialRelationInput' object for properties."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ContactAccountRelation, see: 'updateContactAccountRelationInput' object for properties."}, "description": "Accounts this contact is linked to. Each link records the role and position the contact has at the related account."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ContactSharingSalesUnitRelation, see: 'updateContactSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this contact. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ContactSharingClientRelation, see: 'updateContactSharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this contact. Editable only when share_mode allows user sharing."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this contact."}, "exchange_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "gapi_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "o365_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "primary_account_account_roles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ContactAccountAccountRoleRelation, see: 'updateContactAccountAccountRoleRelationInput' object for properties."}, "description": "Roles of Contact in his primary Account."}, "account_position": {"type": "string", "example": "string", "description": "Job position of Contact in his primary Account or quick account position if Contact has no primary Account."}, "is_unsubscribed": {"type": "boolean", "example": false, "description": "If account has any unsubscribed email."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'updateTagRelationInput' object for properties."}, "description": "Tag labels applied to this contact."}, "static_profiles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProfileRelation, see: 'updateProfileRelationInput' object for properties."}, "description": "Saved view profiles this contact currently matches."}, "primary_account_relationship": {"type": "string", "example": "string", "description": "Org chart relationship of Contact in his primary Account."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ContactAccountAccountRoleRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_role": {"type": "string", "format": "uri", "description": "Role assigned to the contact at the account.\n\nRelation to AccountRole. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountRole' object for properties."}, "contact_account_relation": {"type": "string", "format": "uri", "description": "Contact-account link this role assignment belongs to.\n\nRelation to ContactAccountRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactAccountRelation' object for properties."}, "account_role_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account role."}, "contact_account_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact-account link."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "account_role", "contact_account_relation", "account_role_id", "contact_account_relation_id"]}, "createContactAccountAccountRoleRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "contact_account_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Contact-account link this role assignment belongs to.\n\nRelation to ContactAccountRelation, see: 'createContactAccountRelationInput' object for properties."}, "account_role_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account role."}, "contact_account_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact-account link."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["contact_account_relation", "account_role_id", "contact_account_relation_id"]}, "updateContactAccountAccountRoleRelationInput": {"properties": {"contact_account_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Contact-account link this role assignment belongs to.\n\nRelation to ContactAccountRelation, see: 'updateContactAccountRelationInput' object for properties."}, "account_role_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account role."}, "contact_account_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact-account link."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchContactAccountAccountRoleRelationInput": {"properties": {"contact_account_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Contact-account link this role assignment belongs to.\n\nRelation to ContactAccountRelation, see: 'updateContactAccountRelationInput' object for properties."}, "account_role_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account role."}, "contact_account_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact-account link."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ContactAccountRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account": {"type": "string", "format": "uri", "description": "Account the contact is linked to.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "contact": {"type": "string", "format": "uri", "description": "Contact linked to the account.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "comment": {"type": "string", "example": "string", "description": "Free-form note describing this contact-account link."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact."}, "is_assistant": {"type": "boolean", "example": false, "description": "True when the contact acts as an assistant on the account org chart. Assistant relations cannot have child relations."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row."}, "is_sibling": {"type": "boolean", "example": false, "description": "True when the contact is a sibling node on the account org chart (no parent/child reporting line)."}, "position": {"type": "string", "example": "string", "description": "Job title or position the contact holds at the account."}, "relationship": {"type": "integer", "description": "Org-chart relationship of the contact within the account hierarchy.\n\nInteger enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong", "example": 0, "enum": [0, 1, 2, 3]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "account_roles": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ContactAccountAccountRoleRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactAccountAccountRoleRelation' object for properties."}, "description": "Roles the contact holds within the linked account."}}, "required": ["is_delete_protected", "id", "account", "contact", "account_id", "contact_id", "is_primary"]}, "createContactAccountRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "comment": {"type": "string", "example": "string", "description": "Free-form note describing this contact-account link."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact."}, "is_assistant": {"type": "boolean", "example": false, "description": "True when the contact acts as an assistant on the account org chart. Assistant relations cannot have child relations."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row."}, "is_sibling": {"type": "boolean", "example": false, "description": "True when the contact is a sibling node on the account org chart (no parent/child reporting line)."}, "position": {"type": "string", "example": "string", "description": "Job title or position the contact holds at the account."}, "relationship": {"type": "integer", "description": "Org-chart relationship of the contact within the account hierarchy.\n\nInteger enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong", "example": 0, "enum": [0, 1, 2, 3]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "account_roles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ContactAccountAccountRoleRelation, see: 'createContactAccountAccountRoleRelationInput' object for properties."}, "description": "Roles the contact holds within the linked account."}}, "required": ["account_id", "contact_id", "is_primary"]}, "updateContactAccountRelationInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "comment": {"type": "string", "example": "string", "description": "Free-form note describing this contact-account link."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact."}, "is_assistant": {"type": "boolean", "example": false, "description": "True when the contact acts as an assistant on the account org chart. Assistant relations cannot have child relations."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row."}, "is_sibling": {"type": "boolean", "example": false, "description": "True when the contact is a sibling node on the account org chart (no parent/child reporting line)."}, "position": {"type": "string", "example": "string", "description": "Job title or position the contact holds at the account."}, "relationship": {"type": "integer", "description": "Org-chart relationship of the contact within the account hierarchy.\n\nInteger enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong", "example": 0, "enum": [0, 1, 2, 3]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "account_roles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ContactAccountAccountRoleRelation, see: 'updateContactAccountAccountRoleRelationInput' object for properties."}, "description": "Roles the contact holds within the linked account."}}}, "batchContactAccountRelationInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "comment": {"type": "string", "example": "string", "description": "Free-form note describing this contact-account link."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact."}, "is_assistant": {"type": "boolean", "example": false, "description": "True when the contact acts as an assistant on the account org chart. Assistant relations cannot have child relations."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row."}, "is_sibling": {"type": "boolean", "example": false, "description": "True when the contact is a sibling node on the account org chart (no parent/child reporting line)."}, "position": {"type": "string", "example": "string", "description": "Job title or position the contact holds at the account."}, "relationship": {"type": "integer", "description": "Org-chart relationship of the contact within the account hierarchy.\n\nInteger enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong", "example": 0, "enum": [0, 1, 2, 3]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "account_roles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ContactAccountAccountRoleRelation, see: 'updateContactAccountAccountRoleRelationInput' object for properties."}, "description": "Roles the contact holds within the linked account."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ContactDataExRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "contact": {"type": "string", "format": "uri", "description": "Contact this data relation row applies to.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "data": {"type": "string", "format": "uri", "description": "Data record holding the additional fields linked to this contact.\n\nRelation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact."}, "data_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked data record."}, "data_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier of the data set the linked fields belong to."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "contact", "data", "contact_id", "data_id", "data_set_id"]}, "ContactKPI": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client": {"type": "string", "format": "uri", "description": "User who triggered the KPI event (e.g. created or archived the contact, sent the first email).\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "contact": {"type": "string", "format": "uri", "description": "Contact this KPI event relates to.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "Contact owner at the time the KPI event occurred.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit the triggering user belonged to at the time of the event.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration)."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who triggered the event."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact."}, "kpi": {"type": "integer", "description": "KPI metric this event represents: CreateContact, FirstEmailSent, LastEmailSent, Archive.\n\nInteger enum value: 1 - CreateContact, 2 - LastEmailSent, 3 - FirstEmailSent, 4 - Archive", "example": 1, "enum": [1, 2, 3, 4]}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact owner at the time of the event."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "contact", "owner", "contact_id", "kpi", "owner_id"]}, "createContactKPIInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration)."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who triggered the event."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact."}, "kpi": {"type": "integer", "description": "KPI metric this event represents: CreateContact, FirstEmailSent, LastEmailSent, Archive.\n\nInteger enum value: 1 - CreateContact, 2 - LastEmailSent, 3 - FirstEmailSent, 4 - Archive", "example": 1, "enum": [1, 2, 3, 4]}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact owner at the time of the event."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["contact_id", "kpi", "owner_id"]}, "updateContactKPIInput": {"properties": {"application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration)."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who triggered the event."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact."}, "kpi": {"type": "integer", "description": "KPI metric this event represents: CreateContact, FirstEmailSent, LastEmailSent, Archive.\n\nInteger enum value: 1 - CreateContact, 2 - LastEmailSent, 3 - FirstEmailSent, 4 - Archive", "example": 1, "enum": [1, 2, 3, 4]}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact owner at the time of the event."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchContactKPIInput": {"properties": {"application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration)."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who triggered the event."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact."}, "kpi": {"type": "integer", "description": "KPI metric this event represents: CreateContact, FirstEmailSent, LastEmailSent, Archive.\n\nInteger enum value: 1 - CreateContact, 2 - LastEmailSent, 3 - FirstEmailSent, 4 - Archive", "example": 1, "enum": [1, 2, 3, 4]}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact owner at the time of the event."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ContactRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "contact1": {"type": "string", "format": "uri", "description": "One side of the contact-to-contact relationship.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "contact2": {"type": "string", "format": "uri", "description": "Other side of the contact-to-contact relationship.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "contact1_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the first related contact."}, "contact2_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the second related contact."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "contact1", "contact2", "contact1_id", "contact2_id"]}, "createContactRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "contact1_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the first related contact."}, "contact2_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the second related contact."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["contact1_id", "contact2_id"]}, "updateContactRelationInput": {"properties": {"contact1_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the first related contact."}, "contact2_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the second related contact."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchContactRelationInput": {"properties": {"contact1_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the first related contact."}, "contact2_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the second related contact."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ContactRelationLabel": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "contact_relation": {"type": "string", "format": "uri", "description": "Contact relationship being labelled.\n\nRelation to ContactRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactRelation' object for properties."}, "contact_relation_type": {"type": "string", "format": "uri", "description": "Type of the relationship (e.g. spouse, colleague).\n\nRelation to ContactRelationType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactRelationType' object for properties."}, "contact_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact relationship."}, "contact_relation_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the relationship type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "contact_relation", "contact_relation_type", "contact_relation_id", "contact_relation_type_id"]}, "createContactRelationLabelInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "contact_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Contact relationship being labelled.\n\nRelation to ContactRelation, see: 'createContactRelationInput' object for properties."}, "contact_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact relationship."}, "contact_relation_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the relationship type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["contact_relation", "contact_relation_id", "contact_relation_type_id"]}, "updateContactRelationLabelInput": {"properties": {"contact_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Contact relationship being labelled.\n\nRelation to ContactRelation, see: 'updateContactRelationInput' object for properties."}, "contact_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact relationship."}, "contact_relation_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the relationship type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchContactRelationLabelInput": {"properties": {"contact_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Contact relationship being labelled.\n\nRelation to ContactRelation, see: 'updateContactRelationInput' object for properties."}, "contact_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact relationship."}, "contact_relation_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the relationship type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ContactRelationType": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue."}, "label": {"type": "string", "example": "string", "description": "Display label of the contact-to-contact relationship type (e.g. Spouse, Colleague)."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "color"]}, "createContactRelationTypeInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue."}, "label": {"type": "string", "example": "string", "description": "Display label of the contact-to-contact relationship type (e.g. Spouse, Colleague)."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["color"]}, "updateContactRelationTypeInput": {"properties": {"color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue."}, "label": {"type": "string", "example": "string", "description": "Display label of the contact-to-contact relationship type (e.g. Spouse, Colleague)."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchContactRelationTypeInput": {"properties": {"color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue."}, "label": {"type": "string", "example": "string", "description": "Display label of the contact-to-contact relationship type (e.g. Spouse, Colleague)."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ContactSharingClientRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client": {"type": "string", "format": "uri", "description": "User the contact is shared with.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "contact": {"type": "string", "format": "uri", "description": "Contact being shared.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared contact."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the contact.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "client", "contact", "client_id", "contact_id"]}, "createContactSharingClientRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared contact."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the contact.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["client_id", "contact_id"]}, "updateContactSharingClientRelationInput": {"properties": {"client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared contact."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the contact.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchContactSharingClientRelationInput": {"properties": {"client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared contact."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the contact.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ContactSharingSalesUnitRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "contact": {"type": "string", "format": "uri", "description": "Contact being shared.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit the contact is shared with.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared contact."}, "role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the contact.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "contact", "unit", "contact_id", "unit_id"]}, "createContactSharingSalesUnitRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared contact."}, "role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the contact.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["contact_id", "unit_id"]}, "updateContactSharingSalesUnitRelationInput": {"properties": {"contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared contact."}, "role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the contact.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchContactSharingSalesUnitRelationInput": {"properties": {"contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared contact."}, "role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the contact.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ContactSocialRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity. Must match with Contact id.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "angellist_url": {"type": "string", "example": "string", "description": "AngelList profile URL of the contact."}, "crunchbase_url": {"type": "string", "example": "string", "description": "Crunchbase profile URL of the contact."}, "disqus_url": {"type": "string", "example": "string", "description": "Disqus profile URL of the contact."}, "facebook_id": {"type": "string", "example": "string", "description": "Facebook profile id of the contact."}, "facebook_url": {"type": "string", "example": "string", "description": "Facebook profile URL of the contact."}, "flickr_url": {"type": "string", "example": "string", "description": "Flickr profile URL of the contact."}, "foursquare_url": {"type": "string", "example": "string", "description": "Foursquare profile URL of the contact."}, "google_id": {"type": "string", "example": "string", "description": "Google profile id of the contact."}, "google_plus_url": {"type": "string", "example": "string", "description": "Google+ profile URL of the contact."}, "gravatar_url": {"type": "string", "example": "string", "description": "Gravatar profile URL of the contact."}, "klout_url": {"type": "string", "example": "string", "description": "Klout profile URL of the contact."}, "linkedin_id": {"type": "string", "example": "string", "description": "LinkedIn profile id of the contact."}, "linkedin_url": {"type": "string", "example": "string", "description": "LinkedIn profile URL of the contact."}, "pinterest_url": {"type": "string", "example": "string", "description": "Pinterest profile URL of the contact."}, "quora_url": {"type": "string", "example": "string", "description": "Quora profile URL of the contact."}, "reddit_url": {"type": "string", "example": "string", "description": "Reddit profile URL of the contact."}, "skype_url": {"type": "string", "example": "string", "description": "Skype contact URL or username of the contact."}, "slideshare_url": {"type": "string", "example": "string", "description": "SlideShare profile URL of the contact."}, "twitter_id": {"type": "string", "example": "string", "description": "Twitter (X) user id of the contact."}, "twitter_url": {"type": "string", "example": "string", "description": "Twitter (X) profile URL of the contact."}, "vimeo_url": {"type": "string", "example": "string", "description": "Vimeo profile URL of the contact."}, "wordpress_url": {"type": "string", "example": "string", "description": "WordPress site URL of the contact."}, "xing_url": {"type": "string", "example": "string", "description": "XING profile URL of the contact."}, "yahoo_url": {"type": "string", "example": "string", "description": "Yahoo profile URL of the contact."}, "yelp_url": {"type": "string", "example": "string", "description": "Yelp profile URL of the contact."}, "youtube_url": {"type": "string", "example": "string", "description": "YouTube channel URL of the contact."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id"]}, "createContactSocialRelationInput": {"properties": {"id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity. Must match with Contact id.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "angellist_url": {"type": "string", "example": "string", "description": "AngelList profile URL of the contact."}, "crunchbase_url": {"type": "string", "example": "string", "description": "Crunchbase profile URL of the contact."}, "disqus_url": {"type": "string", "example": "string", "description": "Disqus profile URL of the contact."}, "facebook_id": {"type": "string", "example": "string", "description": "Facebook profile id of the contact."}, "facebook_url": {"type": "string", "example": "string", "description": "Facebook profile URL of the contact."}, "flickr_url": {"type": "string", "example": "string", "description": "Flickr profile URL of the contact."}, "foursquare_url": {"type": "string", "example": "string", "description": "Foursquare profile URL of the contact."}, "google_id": {"type": "string", "example": "string", "description": "Google profile id of the contact."}, "google_plus_url": {"type": "string", "example": "string", "description": "Google+ profile URL of the contact."}, "gravatar_url": {"type": "string", "example": "string", "description": "Gravatar profile URL of the contact."}, "klout_url": {"type": "string", "example": "string", "description": "Klout profile URL of the contact."}, "linkedin_id": {"type": "string", "example": "string", "description": "LinkedIn profile id of the contact."}, "linkedin_url": {"type": "string", "example": "string", "description": "LinkedIn profile URL of the contact."}, "pinterest_url": {"type": "string", "example": "string", "description": "Pinterest profile URL of the contact."}, "quora_url": {"type": "string", "example": "string", "description": "Quora profile URL of the contact."}, "reddit_url": {"type": "string", "example": "string", "description": "Reddit profile URL of the contact."}, "skype_url": {"type": "string", "example": "string", "description": "Skype contact URL or username of the contact."}, "slideshare_url": {"type": "string", "example": "string", "description": "SlideShare profile URL of the contact."}, "twitter_id": {"type": "string", "example": "string", "description": "Twitter (X) user id of the contact."}, "twitter_url": {"type": "string", "example": "string", "description": "Twitter (X) profile URL of the contact."}, "vimeo_url": {"type": "string", "example": "string", "description": "Vimeo profile URL of the contact."}, "wordpress_url": {"type": "string", "example": "string", "description": "WordPress site URL of the contact."}, "xing_url": {"type": "string", "example": "string", "description": "XING profile URL of the contact."}, "yahoo_url": {"type": "string", "example": "string", "description": "Yahoo profile URL of the contact."}, "yelp_url": {"type": "string", "example": "string", "description": "Yelp profile URL of the contact."}, "youtube_url": {"type": "string", "example": "string", "description": "YouTube channel URL of the contact."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["id"]}, "updateContactSocialRelationInput": {"properties": {"angellist_url": {"type": "string", "example": "string", "description": "AngelList profile URL of the contact."}, "crunchbase_url": {"type": "string", "example": "string", "description": "Crunchbase profile URL of the contact."}, "disqus_url": {"type": "string", "example": "string", "description": "Disqus profile URL of the contact."}, "facebook_id": {"type": "string", "example": "string", "description": "Facebook profile id of the contact."}, "facebook_url": {"type": "string", "example": "string", "description": "Facebook profile URL of the contact."}, "flickr_url": {"type": "string", "example": "string", "description": "Flickr profile URL of the contact."}, "foursquare_url": {"type": "string", "example": "string", "description": "Foursquare profile URL of the contact."}, "google_id": {"type": "string", "example": "string", "description": "Google profile id of the contact."}, "google_plus_url": {"type": "string", "example": "string", "description": "Google+ profile URL of the contact."}, "gravatar_url": {"type": "string", "example": "string", "description": "Gravatar profile URL of the contact."}, "klout_url": {"type": "string", "example": "string", "description": "Klout profile URL of the contact."}, "linkedin_id": {"type": "string", "example": "string", "description": "LinkedIn profile id of the contact."}, "linkedin_url": {"type": "string", "example": "string", "description": "LinkedIn profile URL of the contact."}, "pinterest_url": {"type": "string", "example": "string", "description": "Pinterest profile URL of the contact."}, "quora_url": {"type": "string", "example": "string", "description": "Quora profile URL of the contact."}, "reddit_url": {"type": "string", "example": "string", "description": "Reddit profile URL of the contact."}, "skype_url": {"type": "string", "example": "string", "description": "Skype contact URL or username of the contact."}, "slideshare_url": {"type": "string", "example": "string", "description": "SlideShare profile URL of the contact."}, "twitter_id": {"type": "string", "example": "string", "description": "Twitter (X) user id of the contact."}, "twitter_url": {"type": "string", "example": "string", "description": "Twitter (X) profile URL of the contact."}, "vimeo_url": {"type": "string", "example": "string", "description": "Vimeo profile URL of the contact."}, "wordpress_url": {"type": "string", "example": "string", "description": "WordPress site URL of the contact."}, "xing_url": {"type": "string", "example": "string", "description": "XING profile URL of the contact."}, "yahoo_url": {"type": "string", "example": "string", "description": "Yahoo profile URL of the contact."}, "yelp_url": {"type": "string", "example": "string", "description": "Yelp profile URL of the contact."}, "youtube_url": {"type": "string", "example": "string", "description": "YouTube channel URL of the contact."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchContactSocialRelationInput": {"properties": {"angellist_url": {"type": "string", "example": "string", "description": "AngelList profile URL of the contact."}, "crunchbase_url": {"type": "string", "example": "string", "description": "Crunchbase profile URL of the contact."}, "disqus_url": {"type": "string", "example": "string", "description": "Disqus profile URL of the contact."}, "facebook_id": {"type": "string", "example": "string", "description": "Facebook profile id of the contact."}, "facebook_url": {"type": "string", "example": "string", "description": "Facebook profile URL of the contact."}, "flickr_url": {"type": "string", "example": "string", "description": "Flickr profile URL of the contact."}, "foursquare_url": {"type": "string", "example": "string", "description": "Foursquare profile URL of the contact."}, "google_id": {"type": "string", "example": "string", "description": "Google profile id of the contact."}, "google_plus_url": {"type": "string", "example": "string", "description": "Google+ profile URL of the contact."}, "gravatar_url": {"type": "string", "example": "string", "description": "Gravatar profile URL of the contact."}, "klout_url": {"type": "string", "example": "string", "description": "Klout profile URL of the contact."}, "linkedin_id": {"type": "string", "example": "string", "description": "LinkedIn profile id of the contact."}, "linkedin_url": {"type": "string", "example": "string", "description": "LinkedIn profile URL of the contact."}, "pinterest_url": {"type": "string", "example": "string", "description": "Pinterest profile URL of the contact."}, "quora_url": {"type": "string", "example": "string", "description": "Quora profile URL of the contact."}, "reddit_url": {"type": "string", "example": "string", "description": "Reddit profile URL of the contact."}, "skype_url": {"type": "string", "example": "string", "description": "Skype contact URL or username of the contact."}, "slideshare_url": {"type": "string", "example": "string", "description": "SlideShare profile URL of the contact."}, "twitter_id": {"type": "string", "example": "string", "description": "Twitter (X) user id of the contact."}, "twitter_url": {"type": "string", "example": "string", "description": "Twitter (X) profile URL of the contact."}, "vimeo_url": {"type": "string", "example": "string", "description": "Vimeo profile URL of the contact."}, "wordpress_url": {"type": "string", "example": "string", "description": "WordPress site URL of the contact."}, "xing_url": {"type": "string", "example": "string", "description": "XING profile URL of the contact."}, "yahoo_url": {"type": "string", "example": "string", "description": "Yahoo profile URL of the contact."}, "yelp_url": {"type": "string", "example": "string", "description": "Yelp profile URL of the contact."}, "youtube_url": {"type": "string", "example": "string", "description": "YouTube channel URL of the contact."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ContactType": {"properties": {"has_draft": {"type": "boolean", "example": false, "description": "Set to True if draft for entity exists and can be published"}, "is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "form_edit_api": {"type": "object", "description": "API-friendly form definition. Returns the published form merged with any pending draft changes; read via this field, modify via the underlying form_edit / form_lost field through drafts."}, "can_change_readonly": {"type": "boolean", "example": false, "description": "Returns if user can change readonly flag on this entity_type."}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "form_edit": {"type": "object", "description": "JSON definition of the edit form layout used by the UI when creating or editing contacts of this type. Contains tabs, sections, and field placement."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the contact type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "is_published": {"type": "boolean", "example": false, "description": "True when the entity configuration is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["has_draft", "is_delete_protected", "form_edit_api", "id", "is_readonly", "name", "settings"]}, "createContactTypeInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "form_edit": {"type": "object", "description": "JSON definition of the edit form layout used by the UI when creating or editing contacts of this type. Contains tabs, sections, and field placement."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the contact type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "is_published": {"type": "boolean", "example": false, "description": "True when the entity configuration is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_readonly", "name", "settings"]}, "updateContactTypeInput": {"properties": {"form_edit": {"type": "object", "description": "JSON definition of the edit form layout used by the UI when creating or editing contacts of this type. Contains tabs, sections, and field placement."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the contact type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchContactTypeInput": {"properties": {"form_edit": {"type": "object", "description": "JSON definition of the edit form layout used by the UI when creating or editing contacts of this type. Contains tabs, sections, and field placement."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the contact type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "CountryCrm": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "use_lang": {"type": "boolean", "example": false, "description": "Whether the country name is a localization key to be translated into the user language rather than displayed verbatim."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "name"]}, "createCountryCrmInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "use_lang": {"type": "boolean", "example": false, "description": "Whether the country name is a localization key to be translated into the user language rather than displayed verbatim."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["name"]}, "updateCountryCrmInput": {"properties": {"name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "use_lang": {"type": "boolean", "example": false, "description": "Whether the country name is a localization key to be translated into the user language rather than displayed verbatim."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchCountryCrmInput": {"properties": {"name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "use_lang": {"type": "boolean", "example": false, "description": "Whether the country name is a localization key to be translated into the user language rather than displayed verbatim."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Currency": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "code": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "is_base": {"type": "boolean", "example": false, "description": "True for the space's base currency. There is exactly one base currency per space and it cannot be deleted.", "readOnly": true}, "symbol": {"type": "string", "example": "string", "description": "Display symbol of the currency (e.g. \"$\", \"\u20ac\"). Used when formatting amounts in the UI."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "currency_exchange_rates": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to CurrencyExchangeRate. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRate' object for properties."}, "description": "Exchange rates configured for this currency, one per exchange rate list (effective period)."}}, "required": ["is_delete_protected", "id", "code", "currency_exchange_rates"]}, "createCurrencyInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "code": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "symbol": {"type": "string", "example": "string", "description": "Display symbol of the currency (e.g. \"$\", \"\u20ac\"). Used when formatting amounts in the UI."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "currency_exchange_rates": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CurrencyExchangeRate, see: 'createCurrencyExchangeRateInput' object for properties."}, "description": "Exchange rates configured for this currency, one per exchange rate list (effective period)."}}, "required": ["code", "currency_exchange_rates"]}, "updateCurrencyInput": {"properties": {"revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "currency_exchange_rates": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CurrencyExchangeRate, see: 'updateCurrencyExchangeRateInput' object for properties."}, "description": "Exchange rates configured for this currency, one per exchange rate list (effective period)."}}}, "batchCurrencyInput": {"properties": {"revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "currency_exchange_rates": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CurrencyExchangeRate, see: 'updateCurrencyExchangeRateInput' object for properties."}, "description": "Exchange rates configured for this currency, one per exchange rate list (effective period)."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "CurrencyExchangeRate": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "currency_exchange_rate_list": {"type": "string", "format": "uri", "description": "Effective period (exchange rate list) this rate belongs to.\n\nRelation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRatesList' object for properties."}, "currency": {"type": "string", "format": "uri", "description": "Currency the exchange rate applies to. Cannot be the base currency.\n\nRelation to Currency. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Currency' object for properties."}, "currency_exchange_rate_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the exchange rate list."}, "currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency."}, "exchange_rate": {"type": "number", "format": "double", "example": "4.32", "description": "Multiplier for converting an amount in the base currency into this currency. Must be greater than zero."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "currency_exchange_rate_list", "currency", "currency_exchange_rate_list_id", "currency_id"]}, "createCurrencyExchangeRateInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "currency_exchange_rate_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the exchange rate list."}, "currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency."}, "exchange_rate": {"type": "number", "format": "double", "example": "4.32", "description": "Multiplier for converting an amount in the base currency into this currency. Must be greater than zero."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["currency_exchange_rate_list_id", "currency_id"]}, "updateCurrencyExchangeRateInput": {"properties": {"currency_exchange_rate_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the exchange rate list."}, "currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency."}, "exchange_rate": {"type": "number", "format": "double", "example": "4.32", "description": "Multiplier for converting an amount in the base currency into this currency. Must be greater than zero."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchCurrencyExchangeRateInput": {"properties": {"currency_exchange_rate_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the exchange rate list."}, "currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency."}, "exchange_rate": {"type": "number", "format": "double", "example": "4.32", "description": "Multiplier for converting an amount in the base currency into this currency. Must be greater than zero."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "CurrencyExchangeRatesList": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "valid_from": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Date the exchange rate list becomes effective. The list valid for any given moment is the most recent one whose valid_from is in the past. Time component is truncated to midnight on set."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "currency_exchange_rates": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to CurrencyExchangeRate. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRate' object for properties."}, "description": "Exchange rates configured in this list \u2014 one row per non-base currency in the space."}}, "required": ["is_delete_protected", "id", "valid_from", "currency_exchange_rates"]}, "createCurrencyExchangeRatesListInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "valid_from": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Date the exchange rate list becomes effective. The list valid for any given moment is the most recent one whose valid_from is in the past. Time component is truncated to midnight on set."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "currency_exchange_rates": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CurrencyExchangeRate, see: 'createCurrencyExchangeRateInput' object for properties."}, "description": "Exchange rates configured in this list \u2014 one row per non-base currency in the space."}}, "required": ["valid_from", "currency_exchange_rates"]}, "updateCurrencyExchangeRatesListInput": {"properties": {"valid_from": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Date the exchange rate list becomes effective. The list valid for any given moment is the most recent one whose valid_from is in the past. Time component is truncated to midnight on set."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "currency_exchange_rates": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CurrencyExchangeRate, see: 'updateCurrencyExchangeRateInput' object for properties."}, "description": "Exchange rates configured in this list \u2014 one row per non-base currency in the space."}}}, "batchCurrencyExchangeRatesListInput": {"properties": {"valid_from": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Date the exchange rate list becomes effective. The list valid for any given moment is the most recent one whose valid_from is in the past. Time component is truncated to midnight on set."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "currency_exchange_rates": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CurrencyExchangeRate, see: 'updateCurrencyExchangeRateInput' object for properties."}, "description": "Exchange rates configured in this list \u2014 one row per non-base currency in the space."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "CustomEntity": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "currency_exchange_rates_list": {"type": "string", "format": "uri", "description": "Currency exchange rate list used to convert monetary fields linked to this record. Empty to inherit the team space default.\n\nRelation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRatesList' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "Sales user who owns this custom entity record.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "type": {"type": "string", "format": "uri", "description": "Custom entity type that classifies this record. Custom entity types are configurable per team space and define the schema (fields and form) of the records.\n\nRelation to CustomEntityType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntityType' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit this record is assigned to. Determines which team members can see the record under unit-based sharing.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this record."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the record owner."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users).\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "table_name": {"type": "string", "example": "string", "description": "Discriminator identifying which custom entity type this record belongs to. Read-only; matches CustomEntityType.entity_api_name and is used as the entity name in REST and GraphQL queries.", "readOnly": true}, "type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the custom entity type."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "sharing_units": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to CustomEntitySharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntitySharingSalesUnitRelation' object for properties."}, "description": "Sales units that have been granted shared access to this custom entity record. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to CustomEntitySharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntitySharingClientRelation' object for properties."}, "description": "Users that have been granted shared access to this custom entity record. Editable only when share_mode allows user sharing."}, "documents": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties."}, "description": "Documents linked to this custom entity record."}, "static_profiles": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ProfileRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProfileRelation' object for properties."}, "description": "Saved view profiles this custom entity record currently matches."}, "tags": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to TagRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TagRelation' object for properties."}, "description": "Tag labels applied to this custom entity record."}, "is_favorite": {"type": "boolean", "example": false, "description": "True when the current authenticated user has marked this record as favorite. Per-user."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "owner", "type", "unit", "owner_id", "table_name", "is_favorite"]}, "createCustomEntityInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this record."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the record owner."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users).\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the custom entity type."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CustomEntitySharingSalesUnitRelation, see: 'createCustomEntitySharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this custom entity record. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CustomEntitySharingClientRelation, see: 'createCustomEntitySharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this custom entity record. Editable only when share_mode allows user sharing."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this custom entity record."}, "static_profiles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProfileRelation, see: 'createProfileRelationInput' object for properties."}, "description": "Saved view profiles this custom entity record currently matches."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'createTagRelationInput' object for properties."}, "description": "Tag labels applied to this custom entity record."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["owner_id"]}, "updateCustomEntityInput": {"properties": {"currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this record."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the record owner."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users).\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the custom entity type."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CustomEntitySharingSalesUnitRelation, see: 'updateCustomEntitySharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this custom entity record. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CustomEntitySharingClientRelation, see: 'updateCustomEntitySharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this custom entity record. Editable only when share_mode allows user sharing."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this custom entity record."}, "static_profiles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProfileRelation, see: 'updateProfileRelationInput' object for properties."}, "description": "Saved view profiles this custom entity record currently matches."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'updateTagRelationInput' object for properties."}, "description": "Tag labels applied to this custom entity record."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchCustomEntityInput": {"properties": {"currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this record."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the record owner."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users).\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the custom entity type."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CustomEntitySharingSalesUnitRelation, see: 'updateCustomEntitySharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this custom entity record. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CustomEntitySharingClientRelation, see: 'updateCustomEntitySharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this custom entity record. Editable only when share_mode allows user sharing."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this custom entity record."}, "static_profiles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProfileRelation, see: 'updateProfileRelationInput' object for properties."}, "description": "Saved view profiles this custom entity record currently matches."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'updateTagRelationInput' object for properties."}, "description": "Tag labels applied to this custom entity record."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "CustomEntityDataExRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "custom_entity": {"type": "string", "format": "uri", "description": "Relation to single entity instance. Target entity is re-used and not deleted on de-association.\n    Examples:\n         Opportunity.owner -> Client, the Client is reused for many opportunities.\n         Account.picture -> CloudObject, the CloudObject can be reused on many accounts.\n\nRelation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties."}, "data": {"type": "string", "format": "uri", "description": "Relation to single entity instance. Target entity is re-used and not deleted on de-association.\n    Examples:\n         Opportunity.owner -> Client, the Client is reused for many opportunities.\n         Account.picture -> CloudObject, the CloudObject can be reused on many accounts.\n\nRelation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "data_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "data_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Generic field wrapping sqlalchemy column, configurable by constructor.\n    Good for one-of fields / generated fields."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "custom_entity", "data", "custom_entity_id", "data_id", "data_set_id"]}, "createCustomEntityDataExRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "data_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "data_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Generic field wrapping sqlalchemy column, configurable by constructor.\n    Good for one-of fields / generated fields."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["custom_entity_id", "data_id", "data_set_id"]}, "updateCustomEntityDataExRelationInput": {"properties": {"custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "data_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "data_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Generic field wrapping sqlalchemy column, configurable by constructor.\n    Good for one-of fields / generated fields."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchCustomEntityDataExRelationInput": {"properties": {"custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "data_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "data_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Generic field wrapping sqlalchemy column, configurable by constructor.\n    Good for one-of fields / generated fields."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "CustomEntityRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "has_draft": {"type": "boolean", "example": false, "description": "Set to True if draft for entity exists and can be published"}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "field_1": {"type": "string", "format": "uri", "description": "Relation to single entity instance. Target entity is re-used and not deleted on de-association.\n    Examples:\n         Opportunity.owner -> Client, the Client is reused for many opportunities.\n         Account.picture -> CloudObject, the CloudObject can be reused on many accounts.\n\nRelation to Field. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Field' object for properties."}, "field_2": {"type": "string", "format": "uri", "description": "Relation to single entity instance. Target entity is re-used and not deleted on de-association.\n    Examples:\n         Opportunity.owner -> Client, the Client is reused for many opportunities.\n         Account.picture -> CloudObject, the CloudObject can be reused on many accounts.\n\nRelation to Field. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Field' object for properties."}, "entity_filter_1": {"type": "object", "description": "Field containing json."}, "entity_filter_2": {"type": "object", "description": "Field containing json."}, "field_1_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "field_2_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "has_is_primary": {"type": "boolean", "example": false, "description": "Boolean value."}, "show_related_1": {"type": "boolean", "example": false, "description": "Boolean value."}, "show_related_2": {"type": "boolean", "example": false, "description": "Boolean value."}, "show_tab_1": {"type": "boolean", "example": false, "description": "Boolean value."}, "show_tab_2": {"type": "boolean", "example": false, "description": "Boolean value."}, "tab_name_1": {"type": "string", "example": "string", "description": "String value."}, "tab_name_2": {"type": "string", "example": "string", "description": "String value."}, "is_published": {"type": "boolean", "example": false, "description": "True when the entity configuration is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "has_draft", "id", "field_1", "field_2", "field_1_id", "field_2_id", "show_tab_1", "show_tab_2", "tab_name_1", "tab_name_2"]}, "CustomEntityRelationData": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_1": {"type": "string", "format": "uri", "description": "Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "account_2": {"type": "string", "format": "uri", "description": "Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "appointment_1": {"type": "string", "format": "uri", "description": "Relation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties."}, "task_1": {"type": "string", "format": "uri", "description": "Relation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties."}, "appointment_2": {"type": "string", "format": "uri", "description": "Relation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties."}, "task_2": {"type": "string", "format": "uri", "description": "Relation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties."}, "client_1": {"type": "string", "format": "uri", "description": "Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "client_2": {"type": "string", "format": "uri", "description": "Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "contact_1": {"type": "string", "format": "uri", "description": "Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "contact_2": {"type": "string", "format": "uri", "description": "Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "custom_entity_1": {"type": "string", "format": "uri", "description": "Relation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties."}, "custom_entity_2": {"type": "string", "format": "uri", "description": "Relation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties."}, "custom_entity_relation": {"type": "string", "format": "uri", "description": "Relation to single entity instance. Target entity is re-used and not deleted on de-association.\n    Examples:\n         Opportunity.owner -> Client, the Client is reused for many opportunities.\n         Account.picture -> CloudObject, the CloudObject can be reused on many accounts.\n\nRelation to CustomEntityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntityRelation' object for properties."}, "lead_1": {"type": "string", "format": "uri", "description": "Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties."}, "oppty_1": {"type": "string", "format": "uri", "description": "Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "lead_2": {"type": "string", "format": "uri", "description": "Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties."}, "oppty_2": {"type": "string", "format": "uri", "description": "Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "oppty_product_relation_1": {"type": "string", "format": "uri", "description": "Relation to OpptyProductRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelation' object for properties."}, "oppty_product_relation_2": {"type": "string", "format": "uri", "description": "Relation to OpptyProductRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelation' object for properties."}, "product_1": {"type": "string", "format": "uri", "description": "Relation to Product. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Product' object for properties."}, "product_2": {"type": "string", "format": "uri", "description": "Relation to Product. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Product' object for properties."}, "project_1": {"type": "string", "format": "uri", "description": "Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties."}, "project_2": {"type": "string", "format": "uri", "description": "Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties."}, "quote_1": {"type": "string", "format": "uri", "description": "Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties."}, "quote_2": {"type": "string", "format": "uri", "description": "Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties."}, "account_1_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "account_2_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "activity_1_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single abstract entity instance.\n    E.g. Relation to Lead/Oppty"}, "activity_2_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single abstract entity instance.\n    E.g. Relation to Lead/Oppty"}, "client_1_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "client_2_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "contact_1_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "contact_2_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "custom_entity_1_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "custom_entity_2_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "custom_entity_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "is_primary": {"type": "boolean", "example": false, "description": "Boolean value."}, "lead_oppty_1_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single abstract entity instance.\n    E.g. Relation to Lead/Oppty"}, "lead_oppty_2_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single abstract entity instance.\n    E.g. Relation to Lead/Oppty"}, "oppty_product_relation_1_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "oppty_product_relation_2_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "product_1_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "product_2_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "project_1_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "project_2_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "quote_1_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "quote_2_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "custom_entity_relation", "custom_entity_relation_id"]}, "CustomEntitySharingClientRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client": {"type": "string", "format": "uri", "description": "Relation to single entity instance. Target entity is re-used and not deleted on de-association.\n    Examples:\n         Opportunity.owner -> Client, the Client is reused for many opportunities.\n         Account.picture -> CloudObject, the CloudObject can be reused on many accounts.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "custom_entity": {"type": "string", "format": "uri", "description": "Relation to single entity instance. Target entity is re-used and not deleted on de-association.\n    Examples:\n         Opportunity.owner -> Client, the Client is reused for many opportunities.\n         Account.picture -> CloudObject, the CloudObject can be reused on many accounts.\n\nRelation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "role": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "client", "custom_entity", "client_id", "custom_entity_id"]}, "createCustomEntitySharingClientRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "role": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["client_id", "custom_entity_id"]}, "updateCustomEntitySharingClientRelationInput": {"properties": {"client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "role": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchCustomEntitySharingClientRelationInput": {"properties": {"client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "role": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "CustomEntitySharingSalesUnitRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "custom_entity": {"type": "string", "format": "uri", "description": "Relation to single entity instance. Target entity is re-used and not deleted on de-association.\n    Examples:\n         Opportunity.owner -> Client, the Client is reused for many opportunities.\n         Account.picture -> CloudObject, the CloudObject can be reused on many accounts.\n\nRelation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Relation to single entity instance. Target entity is re-used and not deleted on de-association.\n    Examples:\n         Opportunity.owner -> Client, the Client is reused for many opportunities.\n         Account.picture -> CloudObject, the CloudObject can be reused on many accounts.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "role": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "custom_entity", "unit", "custom_entity_id", "unit_id"]}, "createCustomEntitySharingSalesUnitRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "role": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["custom_entity_id", "unit_id"]}, "updateCustomEntitySharingSalesUnitRelationInput": {"properties": {"custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "role": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchCustomEntitySharingSalesUnitRelationInput": {"properties": {"custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "role": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "CustomEntityType": {"properties": {"has_draft": {"type": "boolean", "example": false, "description": "Set to True if draft for entity exists and can be published"}, "is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "form_edit_api": {"type": "object", "description": "API-friendly form definition. Returns the published form merged with any pending draft changes; read via this field, modify via the underlying form_edit / form_lost field through drafts."}, "can_change_readonly": {"type": "boolean", "example": false, "description": "Returns if user can change readonly flag on this entity_type."}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing records of this custom entity type."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the custom entity type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "is_published": {"type": "boolean", "example": false, "description": "True when the entity configuration is published; false while it exists only as an unpublished draft.", "readOnly": true}, "entity_api_name": {"type": "string", "example": "string", "description": "API name of the custom entity type (e.g. \"Vehicle\", \"Project_Phase\"). Used as the entity name when calling REST endpoints or selecting a concrete custom entity in GraphQL."}}, "required": ["has_draft", "is_delete_protected", "form_edit_api", "id", "form_edit", "is_readonly", "name", "settings"]}, "createCustomEntityTypeInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing records of this custom entity type."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the custom entity type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "is_published": {"type": "boolean", "example": false, "description": "True when the entity configuration is published; false while it exists only as an unpublished draft.", "readOnly": true}}, "required": ["form_edit", "is_readonly", "name", "settings"]}, "updateCustomEntityTypeInput": {"properties": {"form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing records of this custom entity type."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the custom entity type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}}}, "batchCustomEntityTypeInput": {"properties": {"form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing records of this custom entity type."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the custom entity type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Data": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "has_draft": {"type": "boolean", "example": false, "description": "Set to True if draft for entity exists and can be published"}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted."}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "allowed_by": {"type": "object", "description": "For dependent dropdowns, the parent-field values this option is available for, as a JSON array of identifiers (option ids or enum names). Empty when always available."}, "calc_value": {"type": "number", "format": "double", "example": 4.32, "description": "Numeric value associated with the option, used in calculation formulas (e.g. score of a dropdown option)."}, "data_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier of the data set this option belongs to. Shared by all options of a dropdown / radio / multiselect field.", "readOnly": true}, "option_name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the option within its data set; lower values appear first."}, "is_published": {"type": "boolean", "example": false, "description": "True when the entity configuration is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "option_name_translations": {"type": "string", "format": "binary", "example": "blob", "description": "Map of locale codes to translated option names (e.g. {\"en-US\": \"Hot\", \"de-DE\": \"Hei\u00df\"}). Empty when no translations are defined."}, "option_name_translated": {"type": "string", "example": "string", "description": "Option name in the current user's language, taken from option_name_translations. Empty when no translation is available for that language."}}, "required": ["is_delete_protected", "has_draft", "id", "data_set_id", "option_name", "sort_order", "option_name_translations", "option_name_translated"]}, "createDataInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "allowed_by": {"type": "object", "description": "For dependent dropdowns, the parent-field values this option is available for, as a JSON array of identifiers (option ids or enum names). Empty when always available."}, "calc_value": {"type": "number", "format": "double", "example": 4.32, "description": "Numeric value associated with the option, used in calculation formulas (e.g. score of a dropdown option)."}, "data_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier of the data set this option belongs to. Shared by all options of a dropdown / radio / multiselect field.", "readOnly": true}, "option_name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the option within its data set; lower values appear first."}, "is_published": {"type": "boolean", "example": false, "description": "True when the entity configuration is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "option_name_translations": {"type": "string", "format": "binary", "example": "blob", "description": "Map of locale codes to translated option names (e.g. {\"en-US\": \"Hot\", \"de-DE\": \"Hei\u00df\"}). Empty when no translations are defined."}}, "required": ["data_set_id", "option_name", "sort_order", "option_name_translations"]}, "updateDataInput": {"properties": {"allowed_by": {"type": "object", "description": "For dependent dropdowns, the parent-field values this option is available for, as a JSON array of identifiers (option ids or enum names). Empty when always available."}, "calc_value": {"type": "number", "format": "double", "example": 4.32, "description": "Numeric value associated with the option, used in calculation formulas (e.g. score of a dropdown option)."}, "option_name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the option within its data set; lower values appear first."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "option_name_translations": {"type": "string", "format": "binary", "example": "blob", "description": "Map of locale codes to translated option names (e.g. {\"en-US\": \"Hot\", \"de-DE\": \"Hei\u00df\"}). Empty when no translations are defined."}}}, "batchDataInput": {"properties": {"allowed_by": {"type": "object", "description": "For dependent dropdowns, the parent-field values this option is available for, as a JSON array of identifiers (option ids or enum names). Empty when always available."}, "calc_value": {"type": "number", "format": "double", "example": 4.32, "description": "Numeric value associated with the option, used in calculation formulas (e.g. score of a dropdown option)."}, "option_name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the option within its data set; lower values appear first."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "option_name_translations": {"type": "string", "format": "binary", "example": "blob", "description": "Map of locale codes to translated option names (e.g. {\"en-US\": \"Hot\", \"de-DE\": \"Hei\u00df\"}). Empty when no translations are defined."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Email": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "company_email": {"type": "string", "format": "uri", "description": "Configured company email used as the From / Reply-To. Empty when sent from the user mailbox.\n\nRelation to CompanyEmail. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CompanyEmail' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "Sales user who owns this email. May be empty for unassigned emails.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "parent_email": {"type": "string", "format": "uri", "description": "For mass emails: the master email this copy was generated from. Empty for the master and for non-mass emails.\n\nRelation to Email. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Email' object for properties."}, "sender_account": {"type": "string", "format": "uri", "description": "Account record matched as the sender, or empty when the sender does not match an existing Account.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "sender_client": {"type": "string", "format": "uri", "description": "Internal user matched as the sender, or empty when the sender is external.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "sender_contact": {"type": "string", "format": "uri", "description": "Contact record matched as the sender, or empty when the sender does not match an existing Contact.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "template": {"type": "string", "format": "uri", "description": "Email template used to compose this email, or empty when none was used.\n\nRelation to EmailTemplate. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailTemplate' object for properties."}, "additional_headers": {"type": "object", "description": "Extra raw email headers preserved from the source message, as a JSON object mapping each header name to a string or a list of strings."}, "body": {"type": "string", "example": "string", "description": "HTML body of the email. Returned only to users with read permission on the email content; otherwise empty."}, "body_summary": {"type": "string", "example": "string", "description": "Plain-text summary of the email body. Returned only to users with read permission on the email content; otherwise empty."}, "cc": {"type": "string", "example": "string", "description": "Comma-separated list of carbon-copy recipients."}, "company_email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the company email."}, "content_share_mode": {"type": "integer", "description": "How the email body is shared with non-owners (e.g. Private hides the body, Public makes it visible to anyone with read access on the email envelope).\n\nInteger enum value: 0 - Custom, 1 - Private, 2 - Public", "example": 0, "enum": [0, 1, 2]}, "content_type": {"type": "string", "example": "string", "description": "MIME content type of the body (e.g. text/html, text/plain)."}, "date_sent": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the email was sent. Empty for drafts and scheduled emails not yet sent."}, "direction": {"type": "integer", "description": "Direction of the email (Incoming, Outgoing).\n\nInteger enum value: 1 - OutgoingEmail, 2 - IncomingEmail", "example": 1, "enum": [1, 2]}, "error_code": {"type": "integer", "format": "int32", "example": 1, "description": "Numeric error code recorded when the email failed to send. Zero when no error occurred."}, "is_tracked": {"type": "boolean", "example": false, "description": "True when delivery tracking is enabled. Tracked emails generate EmailEvent records on open/click."}, "original_id": {"type": "string", "example": "string", "description": "External identifier of the email on the source mailbox (e.g. IMAP Message-ID). Used to deduplicate when re-syncing."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email owner."}, "parent_email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent (master) email."}, "schedule_settings": {"type": "object", "description": "Scheduling configuration for delayed sending, as a JSON object; next_schedule is a numeric timestamp and recipients/cc/bcc are lists."}, "send_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp at which a scheduled email is queued to be sent. Empty for immediately-sent emails."}, "sender": {"type": "string", "example": "string", "description": "Sender address as it appeared on the email (free-text \"From\" header)."}, "sender_account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the matched sender account."}, "sender_client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the matched sender user."}, "sender_contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the matched sender contact."}, "sentiment": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Negative, 1 - Neutral, 2 - Positive", "example": 0, "enum": [0, 1, 2]}, "share_mode": {"type": "integer", "description": "Sharing model for the email envelope (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "subject": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "table_name": {"type": "string", "example": "string", "description": "Discriminator identifying the concrete record type \u2014 always \"email\" for Email records. Read-only; useful when consuming polymorphic Message results.", "readOnly": true}, "template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email template."}, "thread_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier grouping emails belonging to the same conversation thread."}, "to": {"type": "string", "example": "string", "description": "Comma-separated list of primary recipients."}, "type": {"type": "integer", "description": "Email category (e.g. regular email, mass email, calendar invitation).\n\nInteger enum value: 1 - Standard, 2 - Mass", "example": 1, "enum": [1, 2]}, "uid": {"type": "string", "example": "string", "description": "IMAP UID of the email on the source mailbox."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "is_favorite": {"type": "boolean", "example": false, "description": "True when the current authenticated user has marked this email as favorite. Per-user."}, "sharing_units": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to MessageSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageSharingSalesUnitRelation' object for properties."}, "description": "Sales units that have been granted shared access to this email envelope."}, "sharing_clients": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to MessageSharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageSharingClientRelation' object for properties."}, "description": "Users that have been granted shared access to this email envelope."}, "content_sharing_units": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to EmailContentSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailContentSharingSalesUnitRelation' object for properties."}, "description": "Sales units that have been granted access to the email body when content_share_mode is restricted."}, "content_sharing_clients": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to EmailContentSharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailContentSharingClientRelation' object for properties."}, "description": "Users that have been granted access to the email body when content_share_mode is restricted."}, "account_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties."}, "description": "Accounts this email is linked to."}, "contact_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties."}, "description": "Contacts this email is linked to."}, "project_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties."}, "description": "Projects this email is linked to."}, "custom_entity_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties."}, "description": "Custom entity records this email is linked to."}, "lead_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties."}, "description": "Leads this email is linked to."}, "opportunity_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties."}, "description": "Opportunities this email is linked to."}, "quote_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties."}, "description": "Quotes this email is linked to."}, "tags": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to TagRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TagRelation' object for properties."}, "description": "Tag labels applied to this email. Visible only to users that can read the email body."}, "documents": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties."}, "description": "Attachments and other documents linked to this email."}, "mailbox_ids": {"type": "array", "items": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000"}, "description": "Ids of the mailboxes (company or personal) the email envelope belongs to, aggregated from the active email_mailbox_relation rows."}}, "required": ["is_delete_protected", "id", "direction", "table_name", "uid", "is_favorite", "mailbox_ids"]}, "createEmailInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "additional_headers": {"type": "object", "description": "Extra raw email headers preserved from the source message, as a JSON object mapping each header name to a string or a list of strings."}, "body": {"type": "string", "example": "string", "description": "HTML body of the email. Returned only to users with read permission on the email content; otherwise empty."}, "body_summary": {"type": "string", "example": "string", "description": "Plain-text summary of the email body. Returned only to users with read permission on the email content; otherwise empty."}, "cc": {"type": "string", "example": "string", "description": "Comma-separated list of carbon-copy recipients."}, "company_email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the company email."}, "content_share_mode": {"type": "integer", "description": "How the email body is shared with non-owners (e.g. Private hides the body, Public makes it visible to anyone with read access on the email envelope).\n\nInteger enum value: 0 - Custom, 1 - Private, 2 - Public", "example": 0, "enum": [0, 1, 2]}, "content_type": {"type": "string", "example": "string", "description": "MIME content type of the body (e.g. text/html, text/plain)."}, "date_sent": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the email was sent. Empty for drafts and scheduled emails not yet sent."}, "direction": {"type": "integer", "description": "Direction of the email (Incoming, Outgoing).\n\nInteger enum value: 1 - OutgoingEmail, 2 - IncomingEmail", "example": 1, "enum": [1, 2]}, "error_code": {"type": "integer", "format": "int32", "example": 1, "description": "Numeric error code recorded when the email failed to send. Zero when no error occurred."}, "is_tracked": {"type": "boolean", "example": false, "description": "True when delivery tracking is enabled. Tracked emails generate EmailEvent records on open/click."}, "original_id": {"type": "string", "example": "string", "description": "External identifier of the email on the source mailbox (e.g. IMAP Message-ID). Used to deduplicate when re-syncing."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email owner."}, "parent_email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent (master) email."}, "schedule_settings": {"type": "object", "description": "Scheduling configuration for delayed sending, as a JSON object; next_schedule is a numeric timestamp and recipients/cc/bcc are lists."}, "send_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp at which a scheduled email is queued to be sent. Empty for immediately-sent emails."}, "sender": {"type": "string", "example": "string", "description": "Sender address as it appeared on the email (free-text \"From\" header)."}, "sender_account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the matched sender account."}, "sender_client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the matched sender user."}, "sender_contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the matched sender contact."}, "sentiment": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Negative, 1 - Neutral, 2 - Positive", "example": 0, "enum": [0, 1, 2]}, "share_mode": {"type": "integer", "description": "Sharing model for the email envelope (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "subject": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email template."}, "thread_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier grouping emails belonging to the same conversation thread."}, "to": {"type": "string", "example": "string", "description": "Comma-separated list of primary recipients."}, "type": {"type": "integer", "description": "Email category (e.g. regular email, mass email, calendar invitation).\n\nInteger enum value: 1 - Standard, 2 - Mass", "example": 1, "enum": [1, 2]}, "uid": {"type": "string", "example": "string", "description": "IMAP UID of the email on the source mailbox."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageSharingSalesUnitRelation, see: 'createMessageSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this email envelope."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageSharingClientRelation, see: 'createMessageSharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this email envelope."}, "content_sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to EmailContentSharingSalesUnitRelation, see: 'createEmailContentSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted access to the email body when content_share_mode is restricted."}, "content_sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to EmailContentSharingClientRelation, see: 'createEmailContentSharingClientRelationInput' object for properties."}, "description": "Users that have been granted access to the email body when content_share_mode is restricted."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'createMessageRelationInput' object for properties."}, "description": "Accounts this email is linked to."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'createMessageRelationInput' object for properties."}, "description": "Contacts this email is linked to."}, "project_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'createMessageRelationInput' object for properties."}, "description": "Projects this email is linked to."}, "custom_entity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'createMessageRelationInput' object for properties."}, "description": "Custom entity records this email is linked to."}, "lead_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'createMessageRelationInput' object for properties."}, "description": "Leads this email is linked to."}, "opportunity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'createMessageRelationInput' object for properties."}, "description": "Opportunities this email is linked to."}, "quote_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'createMessageRelationInput' object for properties."}, "description": "Quotes this email is linked to."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'createTagRelationInput' object for properties."}, "description": "Tag labels applied to this email. Visible only to users that can read the email body."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties."}, "description": "Attachments and other documents linked to this email."}}, "required": ["direction", "uid"]}, "updateEmailInput": {"properties": {"additional_headers": {"type": "object", "description": "Extra raw email headers preserved from the source message, as a JSON object mapping each header name to a string or a list of strings."}, "body": {"type": "string", "example": "string", "description": "HTML body of the email. Returned only to users with read permission on the email content; otherwise empty."}, "body_summary": {"type": "string", "example": "string", "description": "Plain-text summary of the email body. Returned only to users with read permission on the email content; otherwise empty."}, "cc": {"type": "string", "example": "string", "description": "Comma-separated list of carbon-copy recipients."}, "company_email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the company email."}, "content_share_mode": {"type": "integer", "description": "How the email body is shared with non-owners (e.g. Private hides the body, Public makes it visible to anyone with read access on the email envelope).\n\nInteger enum value: 0 - Custom, 1 - Private, 2 - Public", "example": 0, "enum": [0, 1, 2]}, "content_type": {"type": "string", "example": "string", "description": "MIME content type of the body (e.g. text/html, text/plain)."}, "date_sent": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the email was sent. Empty for drafts and scheduled emails not yet sent."}, "direction": {"type": "integer", "description": "Direction of the email (Incoming, Outgoing).\n\nInteger enum value: 1 - OutgoingEmail, 2 - IncomingEmail", "example": 1, "enum": [1, 2]}, "error_code": {"type": "integer", "format": "int32", "example": 1, "description": "Numeric error code recorded when the email failed to send. Zero when no error occurred."}, "is_tracked": {"type": "boolean", "example": false, "description": "True when delivery tracking is enabled. Tracked emails generate EmailEvent records on open/click."}, "original_id": {"type": "string", "example": "string", "description": "External identifier of the email on the source mailbox (e.g. IMAP Message-ID). Used to deduplicate when re-syncing."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email owner."}, "parent_email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent (master) email."}, "schedule_settings": {"type": "object", "description": "Scheduling configuration for delayed sending, as a JSON object; next_schedule is a numeric timestamp and recipients/cc/bcc are lists."}, "send_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp at which a scheduled email is queued to be sent. Empty for immediately-sent emails."}, "sender": {"type": "string", "example": "string", "description": "Sender address as it appeared on the email (free-text \"From\" header)."}, "sender_account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the matched sender account."}, "sender_client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the matched sender user."}, "sender_contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the matched sender contact."}, "sentiment": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Negative, 1 - Neutral, 2 - Positive", "example": 0, "enum": [0, 1, 2]}, "share_mode": {"type": "integer", "description": "Sharing model for the email envelope (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "subject": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email template."}, "thread_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier grouping emails belonging to the same conversation thread."}, "to": {"type": "string", "example": "string", "description": "Comma-separated list of primary recipients."}, "type": {"type": "integer", "description": "Email category (e.g. regular email, mass email, calendar invitation).\n\nInteger enum value: 1 - Standard, 2 - Mass", "example": 1, "enum": [1, 2]}, "uid": {"type": "string", "example": "string", "description": "IMAP UID of the email on the source mailbox."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageSharingSalesUnitRelation, see: 'updateMessageSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this email envelope."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageSharingClientRelation, see: 'updateMessageSharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this email envelope."}, "content_sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to EmailContentSharingSalesUnitRelation, see: 'updateEmailContentSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted access to the email body when content_share_mode is restricted."}, "content_sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to EmailContentSharingClientRelation, see: 'updateEmailContentSharingClientRelationInput' object for properties."}, "description": "Users that have been granted access to the email body when content_share_mode is restricted."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Accounts this email is linked to."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Contacts this email is linked to."}, "project_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Projects this email is linked to."}, "custom_entity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Custom entity records this email is linked to."}, "lead_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Leads this email is linked to."}, "opportunity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Opportunities this email is linked to."}, "quote_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Quotes this email is linked to."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'updateTagRelationInput' object for properties."}, "description": "Tag labels applied to this email. Visible only to users that can read the email body."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Attachments and other documents linked to this email."}}}, "batchEmailInput": {"properties": {"additional_headers": {"type": "object", "description": "Extra raw email headers preserved from the source message, as a JSON object mapping each header name to a string or a list of strings."}, "body": {"type": "string", "example": "string", "description": "HTML body of the email. Returned only to users with read permission on the email content; otherwise empty."}, "body_summary": {"type": "string", "example": "string", "description": "Plain-text summary of the email body. Returned only to users with read permission on the email content; otherwise empty."}, "cc": {"type": "string", "example": "string", "description": "Comma-separated list of carbon-copy recipients."}, "company_email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the company email."}, "content_share_mode": {"type": "integer", "description": "How the email body is shared with non-owners (e.g. Private hides the body, Public makes it visible to anyone with read access on the email envelope).\n\nInteger enum value: 0 - Custom, 1 - Private, 2 - Public", "example": 0, "enum": [0, 1, 2]}, "content_type": {"type": "string", "example": "string", "description": "MIME content type of the body (e.g. text/html, text/plain)."}, "date_sent": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the email was sent. Empty for drafts and scheduled emails not yet sent."}, "direction": {"type": "integer", "description": "Direction of the email (Incoming, Outgoing).\n\nInteger enum value: 1 - OutgoingEmail, 2 - IncomingEmail", "example": 1, "enum": [1, 2]}, "error_code": {"type": "integer", "format": "int32", "example": 1, "description": "Numeric error code recorded when the email failed to send. Zero when no error occurred."}, "is_tracked": {"type": "boolean", "example": false, "description": "True when delivery tracking is enabled. Tracked emails generate EmailEvent records on open/click."}, "original_id": {"type": "string", "example": "string", "description": "External identifier of the email on the source mailbox (e.g. IMAP Message-ID). Used to deduplicate when re-syncing."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email owner."}, "parent_email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent (master) email."}, "schedule_settings": {"type": "object", "description": "Scheduling configuration for delayed sending, as a JSON object; next_schedule is a numeric timestamp and recipients/cc/bcc are lists."}, "send_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp at which a scheduled email is queued to be sent. Empty for immediately-sent emails."}, "sender": {"type": "string", "example": "string", "description": "Sender address as it appeared on the email (free-text \"From\" header)."}, "sender_account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the matched sender account."}, "sender_client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the matched sender user."}, "sender_contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the matched sender contact."}, "sentiment": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Negative, 1 - Neutral, 2 - Positive", "example": 0, "enum": [0, 1, 2]}, "share_mode": {"type": "integer", "description": "Sharing model for the email envelope (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "subject": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email template."}, "thread_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier grouping emails belonging to the same conversation thread."}, "to": {"type": "string", "example": "string", "description": "Comma-separated list of primary recipients."}, "type": {"type": "integer", "description": "Email category (e.g. regular email, mass email, calendar invitation).\n\nInteger enum value: 1 - Standard, 2 - Mass", "example": 1, "enum": [1, 2]}, "uid": {"type": "string", "example": "string", "description": "IMAP UID of the email on the source mailbox."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageSharingSalesUnitRelation, see: 'updateMessageSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this email envelope."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageSharingClientRelation, see: 'updateMessageSharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this email envelope."}, "content_sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to EmailContentSharingSalesUnitRelation, see: 'updateEmailContentSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted access to the email body when content_share_mode is restricted."}, "content_sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to EmailContentSharingClientRelation, see: 'updateEmailContentSharingClientRelationInput' object for properties."}, "description": "Users that have been granted access to the email body when content_share_mode is restricted."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Accounts this email is linked to."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Contacts this email is linked to."}, "project_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Projects this email is linked to."}, "custom_entity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Custom entity records this email is linked to."}, "lead_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Leads this email is linked to."}, "opportunity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Opportunities this email is linked to."}, "quote_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Quotes this email is linked to."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'updateTagRelationInput' object for properties."}, "description": "Tag labels applied to this email. Visible only to users that can read the email body."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Attachments and other documents linked to this email."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "EmailContentSharingClientRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client": {"type": "string", "format": "uri", "description": "User granted access to the email body.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "email": {"type": "string", "format": "uri", "description": "Email whose body is being shared.\n\nRelation to Email. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Email' object for properties."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "client", "email", "client_id", "email_id"]}, "createEmailContentSharingClientRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["client_id", "email_id"]}, "updateEmailContentSharingClientRelationInput": {"properties": {"client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchEmailContentSharingClientRelationInput": {"properties": {"client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "EmailContentSharingSalesUnitRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "email": {"type": "string", "format": "uri", "description": "Email whose body is being shared.\n\nRelation to Email. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Email' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit granted access to the email body.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "email", "unit", "email_id", "unit_id"]}, "createEmailContentSharingSalesUnitRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["email_id", "unit_id"]}, "updateEmailContentSharingSalesUnitRelationInput": {"properties": {"email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchEmailContentSharingSalesUnitRelationInput": {"properties": {"email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "EmailEvent": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "email": {"type": "string", "format": "uri", "description": "Email message the event was reported for.\n\nRelation to Email. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Email' object for properties."}, "additional_data": {"type": "object", "description": "Provider-specific extra data captured with the event (e.g. user agent, ip), as a JSON document."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email message."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Open, 2 - Click, 3 - Unsubscribe, 4 - Bounce, 5 - Reply, 6 - BounceSoft", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "url": {"type": "string", "example": "string", "description": "URL the recipient interacted with. Set for click events; empty for other event types."}}, "required": ["is_delete_protected", "id", "email", "email_id"]}, "createEmailEventInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "additional_data": {"type": "object", "description": "Provider-specific extra data captured with the event (e.g. user agent, ip), as a JSON document."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email message."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Open, 2 - Click, 3 - Unsubscribe, 4 - Bounce, 5 - Reply, 6 - BounceSoft", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "url": {"type": "string", "example": "string", "description": "URL the recipient interacted with. Set for click events; empty for other event types."}}, "required": ["email_id"]}, "updateEmailEventInput": {"properties": {"additional_data": {"type": "object", "description": "Provider-specific extra data captured with the event (e.g. user agent, ip), as a JSON document."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email message."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Open, 2 - Click, 3 - Unsubscribe, 4 - Bounce, 5 - Reply, 6 - BounceSoft", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "url": {"type": "string", "example": "string", "description": "URL the recipient interacted with. Set for click events; empty for other event types."}}}, "batchEmailEventInput": {"properties": {"additional_data": {"type": "object", "description": "Provider-specific extra data captured with the event (e.g. user agent, ip), as a JSON document."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email message."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Open, 2 - Click, 3 - Unsubscribe, 4 - Bounce, 5 - Reply, 6 - BounceSoft", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "url": {"type": "string", "example": "string", "description": "URL the recipient interacted with. Set for click events; empty for other event types."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "EmailMailboxRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "email": {"type": "string", "format": "uri", "description": "Email that belongs to the mailbox.\n\nRelation to Email. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Email' object for properties."}, "direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - OutgoingEmail, 2 - IncomingEmail", "example": 1, "enum": [1, 2]}, "email_created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email that belongs to the mailbox."}, "email_is_deleted": {"type": "boolean", "example": false, "description": "Denormalized flag indicating that the related email has been deleted from this mailbox; such relations are hidden from the inbox view."}, "error_code": {"type": "integer", "format": "int32", "example": 1, "description": "Error code for the email in this mailbox; 0 means the email was processed without error."}, "event_types": {"type": "string", "example": 2, "enum": [2, 4, 8, 16, 32, 64], "description": "Field whose values are strictly defined with an enumeration of values."}, "is_scheduled": {"type": "boolean", "example": false, "description": "Whether the email is scheduled to be sent at a future time and has not been sent yet."}, "mailbox_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the mailbox (connected email account) the email belongs to."}, "sent_or_scheduled_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Time when the email was sent, or its scheduled send time if it has not been sent yet."}, "thread_or_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email thread, or the id of the email itself when it does not belong to a thread."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Standard, 2 - Mass", "example": 1, "enum": [1, 2]}}, "required": ["is_delete_protected", "id", "email", "email_id", "mailbox_id"]}, "createEmailMailboxRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - OutgoingEmail, 2 - IncomingEmail", "example": 1, "enum": [1, 2]}, "email_created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email that belongs to the mailbox."}, "email_is_deleted": {"type": "boolean", "example": false, "description": "Denormalized flag indicating that the related email has been deleted from this mailbox; such relations are hidden from the inbox view."}, "error_code": {"type": "integer", "format": "int32", "example": 1, "description": "Error code for the email in this mailbox; 0 means the email was processed without error."}, "event_types": {"type": "string", "example": 2, "enum": [2, 4, 8, 16, 32, 64], "description": "Field whose values are strictly defined with an enumeration of values."}, "is_scheduled": {"type": "boolean", "example": false, "description": "Whether the email is scheduled to be sent at a future time and has not been sent yet."}, "mailbox_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the mailbox (connected email account) the email belongs to."}, "sent_or_scheduled_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Time when the email was sent, or its scheduled send time if it has not been sent yet."}, "thread_or_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email thread, or the id of the email itself when it does not belong to a thread."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Standard, 2 - Mass", "example": 1, "enum": [1, 2]}}, "required": ["email_id", "mailbox_id"]}, "updateEmailMailboxRelationInput": {"properties": {"direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - OutgoingEmail, 2 - IncomingEmail", "example": 1, "enum": [1, 2]}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email that belongs to the mailbox."}, "email_is_deleted": {"type": "boolean", "example": false, "description": "Denormalized flag indicating that the related email has been deleted from this mailbox; such relations are hidden from the inbox view."}, "error_code": {"type": "integer", "format": "int32", "example": 1, "description": "Error code for the email in this mailbox; 0 means the email was processed without error."}, "event_types": {"type": "string", "example": 2, "enum": [2, 4, 8, 16, 32, 64], "description": "Field whose values are strictly defined with an enumeration of values."}, "is_scheduled": {"type": "boolean", "example": false, "description": "Whether the email is scheduled to be sent at a future time and has not been sent yet."}, "mailbox_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the mailbox (connected email account) the email belongs to."}, "sent_or_scheduled_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Time when the email was sent, or its scheduled send time if it has not been sent yet."}, "thread_or_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email thread, or the id of the email itself when it does not belong to a thread."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Standard, 2 - Mass", "example": 1, "enum": [1, 2]}}}, "batchEmailMailboxRelationInput": {"properties": {"direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - OutgoingEmail, 2 - IncomingEmail", "example": 1, "enum": [1, 2]}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email that belongs to the mailbox."}, "email_is_deleted": {"type": "boolean", "example": false, "description": "Denormalized flag indicating that the related email has been deleted from this mailbox; such relations are hidden from the inbox view."}, "error_code": {"type": "integer", "format": "int32", "example": 1, "description": "Error code for the email in this mailbox; 0 means the email was processed without error."}, "event_types": {"type": "string", "example": 2, "enum": [2, 4, 8, 16, 32, 64], "description": "Field whose values are strictly defined with an enumeration of values."}, "is_scheduled": {"type": "boolean", "example": false, "description": "Whether the email is scheduled to be sent at a future time and has not been sent yet."}, "mailbox_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the mailbox (connected email account) the email belongs to."}, "sent_or_scheduled_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Time when the email was sent, or its scheduled send time if it has not been sent yet."}, "thread_or_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email thread, or the id of the email itself when it does not belong to a thread."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Standard, 2 - Mass", "example": 1, "enum": [1, 2]}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "EmailSequence": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "owner": {"type": "string", "format": "uri", "description": "User who owns this email sequence.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "deactivation_reason": {"type": "integer", "description": "Reason the sequence is currently disabled (e.g. Manual stop, system suspension). Read-only.\n\nInteger enum value: 0 - NoReason, 1 - Manual, 2 - TooManyErrors, 3 - DisabledFeature", "example": 0, "enum": [0, 1, 2, 3]}, "description": {"type": "string", "example": "string", "description": "Free-form description of the sequence."}, "is_enabled": {"type": "boolean", "example": false, "description": "Master switch for the sequence. Read-only on this surface \u2014 change it via the enable / disable mutations."}, "last_schema_change": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent change to settings. Read-only."}, "last_status_change": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent change to is_enabled. Read-only."}, "name": {"type": "string", "example": "string", "description": "Display name of the email sequence."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email sequence owner."}, "settings": {"type": "object", "description": "JSON schema describing the sequence trigger, nodes (steps) and global actions (e.g. on-reply, on-bounce, on-unsubscribe)."}, "type": {"type": "integer", "description": "Process category of the sequence (e.g. EmailSequence vs other process types).\n\nInteger enum value: 1 - Personal, 2 - Space", "example": 1, "enum": [1, 2]}, "activity_logs": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to EmailSequenceActivityLog. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailSequenceActivityLog' object for properties."}, "description": "Run history of the sequence \u2014 one log per scheduled execution."}, "documents": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties."}, "description": "Attachments and other documents linked to this sequence."}, "enrolled": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to EmailSequenceEnrolled. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailSequenceEnrolled' object for properties."}, "description": "Enrolment records (recipients currently or previously running through the sequence)."}}, "required": ["is_delete_protected", "id", "owner", "name", "owner_id", "type"]}, "createEmailSequenceInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "description": {"type": "string", "example": "string", "description": "Free-form description of the sequence."}, "name": {"type": "string", "example": "string", "description": "Display name of the email sequence."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email sequence owner."}, "settings": {"type": "object", "description": "JSON schema describing the sequence trigger, nodes (steps) and global actions (e.g. on-reply, on-bounce, on-unsubscribe)."}, "type": {"type": "integer", "description": "Process category of the sequence (e.g. EmailSequence vs other process types).\n\nInteger enum value: 1 - Personal, 2 - Space", "example": 1, "enum": [1, 2]}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties."}, "description": "Attachments and other documents linked to this sequence."}}, "required": ["name", "owner_id", "type"]}, "updateEmailSequenceInput": {"properties": {"description": {"type": "string", "example": "string", "description": "Free-form description of the sequence."}, "name": {"type": "string", "example": "string", "description": "Display name of the email sequence."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email sequence owner."}, "settings": {"type": "object", "description": "JSON schema describing the sequence trigger, nodes (steps) and global actions (e.g. on-reply, on-bounce, on-unsubscribe)."}, "type": {"type": "integer", "description": "Process category of the sequence (e.g. EmailSequence vs other process types).\n\nInteger enum value: 1 - Personal, 2 - Space", "example": 1, "enum": [1, 2]}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Attachments and other documents linked to this sequence."}}}, "batchEmailSequenceInput": {"properties": {"description": {"type": "string", "example": "string", "description": "Free-form description of the sequence."}, "name": {"type": "string", "example": "string", "description": "Display name of the email sequence."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email sequence owner."}, "settings": {"type": "object", "description": "JSON schema describing the sequence trigger, nodes (steps) and global actions (e.g. on-reply, on-bounce, on-unsubscribe)."}, "type": {"type": "integer", "description": "Process category of the sequence (e.g. EmailSequence vs other process types).\n\nInteger enum value: 1 - Personal, 2 - Space", "example": 1, "enum": [1, 2]}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Attachments and other documents linked to this sequence."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "EmailSequenceActivityLog": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "actor": {"type": "string", "format": "uri", "description": "User who initiated the run, or empty for runs triggered by automation.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "application": {"type": "string", "format": "uri", "description": "Application context the run was triggered in (e.g. browser, automation, third-party integration).\n\nRelation to Application. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Application' object for properties."}, "email_sequence": {"type": "string", "format": "uri", "description": "Email sequence this activity log belongs to.\n\nRelation to EmailSequence. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailSequence' object for properties."}, "actor_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the actor."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the application."}, "email_sequence_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email sequence."}, "end_time": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp when the run finished. Empty for runs still in progress."}, "is_test_run": {"type": "boolean", "example": false, "description": "True when the run was a dry-run / test execution and did not produce real-side effects."}, "start_time": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp when the run started."}, "status": {"type": "integer", "description": "Outcome of the run (e.g. Ok, Error, Cancelled).\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}, "lines": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to EmailSequenceActivityLogLine. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailSequenceActivityLogLine' object for properties."}, "description": "Step-by-step log lines produced during the run."}, "record_name": {"type": "string", "example": "string", "description": "Display name of the record this run enrolled (e.g. contact name). Read-only; computed by Coevera."}, "record_email": {"type": "string", "example": "string", "description": "Email address of the record this run enrolled. Read-only; computed by Coevera."}}, "required": ["is_delete_protected", "id", "application", "email_sequence", "application_id", "email_sequence_id", "start_time", "status"]}, "createEmailSequenceActivityLogInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "actor_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the actor."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the application."}, "email_sequence_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email sequence."}, "end_time": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp when the run finished. Empty for runs still in progress."}, "is_test_run": {"type": "boolean", "example": false, "description": "True when the run was a dry-run / test execution and did not produce real-side effects."}, "start_time": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp when the run started."}, "status": {"type": "integer", "description": "Outcome of the run (e.g. Ok, Error, Cancelled).\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}}, "required": ["application_id", "email_sequence_id", "start_time", "status"]}, "updateEmailSequenceActivityLogInput": {"properties": {"actor_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the actor."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the application."}, "email_sequence_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email sequence."}, "end_time": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp when the run finished. Empty for runs still in progress."}, "is_test_run": {"type": "boolean", "example": false, "description": "True when the run was a dry-run / test execution and did not produce real-side effects."}, "start_time": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp when the run started."}, "status": {"type": "integer", "description": "Outcome of the run (e.g. Ok, Error, Cancelled).\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}}}, "batchEmailSequenceActivityLogInput": {"properties": {"actor_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the actor."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the application."}, "email_sequence_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email sequence."}, "end_time": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp when the run finished. Empty for runs still in progress."}, "is_test_run": {"type": "boolean", "example": false, "description": "True when the run was a dry-run / test execution and did not produce real-side effects."}, "start_time": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp when the run started."}, "status": {"type": "integer", "description": "Outcome of the run (e.g. Ok, Error, Cancelled).\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "EmailSequenceActivityLogLine": {"properties": {"formatted_text": {"type": "string", "example": "string", "description": "Human-readable rendering of the log line, prefixed with the line's timestamp and (when applicable) the parent record id."}, "is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "email_sequence_activity_log": {"type": "string", "format": "uri", "description": "Activity log this line belongs to.\n\nRelation to EmailSequenceActivityLog. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailSequenceActivityLog' object for properties."}, "email_sequence_activity_log_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the activity log."}, "is_visible": {"type": "boolean", "example": false, "description": "True when the line is shown in the activity log UI; false for internal-only lines."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the line within its log run."}, "status": {"type": "integer", "description": "Outcome of the step the line represents (e.g. Ok, Error, Skipped).\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}}, "required": ["formatted_text", "is_delete_protected", "id", "email_sequence_activity_log", "email_sequence_activity_log_id", "sort_order"]}, "createEmailSequenceActivityLogLineInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "email_sequence_activity_log_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the activity log."}, "is_visible": {"type": "boolean", "example": false, "description": "True when the line is shown in the activity log UI; false for internal-only lines."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the line within its log run."}, "status": {"type": "integer", "description": "Outcome of the step the line represents (e.g. Ok, Error, Skipped).\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}}, "required": ["email_sequence_activity_log_id", "sort_order"]}, "updateEmailSequenceActivityLogLineInput": {"properties": {"email_sequence_activity_log_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the activity log."}, "is_visible": {"type": "boolean", "example": false, "description": "True when the line is shown in the activity log UI; false for internal-only lines."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the line within its log run."}, "status": {"type": "integer", "description": "Outcome of the step the line represents (e.g. Ok, Error, Skipped).\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}}}, "batchEmailSequenceActivityLogLineInput": {"properties": {"email_sequence_activity_log_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the activity log."}, "is_visible": {"type": "boolean", "example": false, "description": "True when the line is shown in the activity log UI; false for internal-only lines."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the line within its log run."}, "status": {"type": "integer", "description": "Outcome of the step the line represents (e.g. Ok, Error, Skipped).\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "EmailSequenceEnrolled": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account": {"type": "string", "format": "uri", "description": "Account that was enrolled, when the trigger entity is an Account; otherwise empty.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "actor": {"type": "string", "format": "uri", "description": "User who triggered the enrolment, or empty for runs triggered by automation.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "application": {"type": "string", "format": "uri", "description": "Application context the enrolment was triggered in.\n\nRelation to Application. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Application' object for properties."}, "contact": {"type": "string", "format": "uri", "description": "Contact that was enrolled, when the trigger entity is a Contact; otherwise empty.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "email_sequence_activity_log": {"type": "string", "format": "uri", "description": "Activity log run that produced this enrolment.\n\nRelation to EmailSequenceActivityLog. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailSequenceActivityLog' object for properties."}, "email_sequence": {"type": "string", "format": "uri", "description": "Email sequence this enrolment belongs to.\n\nRelation to EmailSequence. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailSequence' object for properties."}, "lead": {"type": "string", "format": "uri", "description": "Lead that was enrolled, when the trigger entity is a Lead; otherwise empty.\n\nRelation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties."}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity that was enrolled, when the trigger entity is an Opportunity; otherwise empty.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "project": {"type": "string", "format": "uri", "description": "Project that was enrolled, when the trigger entity is a Project; otherwise empty.\n\nRelation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the enrolled account."}, "actor_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the actor."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the application."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the enrolled contact."}, "email_sequence_activity_log_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the activity log."}, "email_sequence_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email sequence."}, "end_reason": {"type": "integer", "description": "Why the enrolment ended (e.g. Reply, Unsubscribe, Bounce, Manual, Completed).\n\nInteger enum value: 0 - NoReason, 1 - Unenrolled, 2 - Finished", "example": 0, "enum": [0, 1, 2]}, "end_time": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp when the enrolment ended (completed or unenrolled). Empty while the enrolment is active."}, "entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the enrolled entity (matches whichever of account/contact/lead/oppty/project is set). Read-only.", "readOnly": true}, "entity_type": {"type": "integer", "description": "Type of the enrolled entity (e.g. Account, Contact, Lead). Read-only.\n\nInteger enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12], "readOnly": true}, "excluded_from_stats": {"type": "boolean", "example": false, "description": "True when this enrolment is excluded from sequence statistics (e.g. after a stats reset)."}, "lead_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the enrolled lead."}, "oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the enrolled opportunity."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the enrolled project."}, "start_time": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp when the enrolment started."}, "step_count": {"type": "integer", "format": "int32", "example": 1, "description": "Number of steps the enrolment has reached. Read-only."}, "step_index": {"type": "integer", "format": "int32", "example": 1, "description": "Zero-based index of the next step the enrolment will execute (i.e. one past the highest step_index recorded in EmailSequenceEnrolledStatus). Empty before the first step runs."}, "entity_name": {"type": "string", "example": "string", "description": "Name of the enrolled entity (Account, Contact, Lead, Opportunity, or Project), derived from entity_type."}}, "required": ["is_delete_protected", "id", "application", "email_sequence_activity_log", "email_sequence", "application_id", "email_sequence_activity_log_id", "email_sequence_id", "entity_id", "entity_type", "start_time", "step_count", "entity_name"]}, "createEmailSequenceEnrolledInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the enrolled account."}, "actor_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the actor."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the application."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the enrolled contact."}, "email_sequence_activity_log_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the activity log."}, "email_sequence_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email sequence."}, "end_reason": {"type": "integer", "description": "Why the enrolment ended (e.g. Reply, Unsubscribe, Bounce, Manual, Completed).\n\nInteger enum value: 0 - NoReason, 1 - Unenrolled, 2 - Finished", "example": 0, "enum": [0, 1, 2]}, "end_time": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp when the enrolment ended (completed or unenrolled). Empty while the enrolment is active."}, "excluded_from_stats": {"type": "boolean", "example": false, "description": "True when this enrolment is excluded from sequence statistics (e.g. after a stats reset)."}, "lead_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the enrolled lead."}, "oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the enrolled opportunity."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the enrolled project."}, "start_time": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp when the enrolment started."}}, "required": ["application_id", "email_sequence_activity_log_id", "email_sequence_id", "start_time"]}, "updateEmailSequenceEnrolledInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the enrolled account."}, "actor_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the actor."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the application."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the enrolled contact."}, "email_sequence_activity_log_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the activity log."}, "email_sequence_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email sequence."}, "end_reason": {"type": "integer", "description": "Why the enrolment ended (e.g. Reply, Unsubscribe, Bounce, Manual, Completed).\n\nInteger enum value: 0 - NoReason, 1 - Unenrolled, 2 - Finished", "example": 0, "enum": [0, 1, 2]}, "end_time": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp when the enrolment ended (completed or unenrolled). Empty while the enrolment is active."}, "excluded_from_stats": {"type": "boolean", "example": false, "description": "True when this enrolment is excluded from sequence statistics (e.g. after a stats reset)."}, "lead_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the enrolled lead."}, "oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the enrolled opportunity."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the enrolled project."}, "start_time": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp when the enrolment started."}}}, "batchEmailSequenceEnrolledInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the enrolled account."}, "actor_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the actor."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the application."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the enrolled contact."}, "email_sequence_activity_log_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the activity log."}, "email_sequence_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email sequence."}, "end_reason": {"type": "integer", "description": "Why the enrolment ended (e.g. Reply, Unsubscribe, Bounce, Manual, Completed).\n\nInteger enum value: 0 - NoReason, 1 - Unenrolled, 2 - Finished", "example": 0, "enum": [0, 1, 2]}, "end_time": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp when the enrolment ended (completed or unenrolled). Empty while the enrolment is active."}, "excluded_from_stats": {"type": "boolean", "example": false, "description": "True when this enrolment is excluded from sequence statistics (e.g. after a stats reset)."}, "lead_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the enrolled lead."}, "oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the enrolled opportunity."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the enrolled project."}, "start_time": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp when the enrolment started."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "EmailTemplate": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "email_template_folder": {"type": "string", "format": "uri", "description": "Folder in the template hierarchy that the template belongs to. Empty for templates at the root level.\n\nRelation to EmailTemplateFolder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailTemplateFolder' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "User who owns the template.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "body": {"type": "string", "example": "string", "description": "HTML body of the template. May use merge-field placeholders that are filled with record values when the template is composed."}, "email_template_folder_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the folder."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the template owner."}, "recent_colors": {"type": "object", "description": "List of integers."}, "share_mode": {"type": "integer", "description": "Sharing model for the template (e.g. shared with selected sales units, selected users, or open for editing by all).\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "sharing_url_is_enabled": {"type": "boolean", "example": false, "description": "When true, the template's public sharing URL is active and accessible. Setting to false invalidates outstanding sharing URLs."}, "sharing_url_settings": {"type": "object", "description": "Public sharing-link configuration: resolved URL plus optional personalisation context (entity type, entity id) used to pre-fill merge fields. Empty when no sharing link is configured."}, "subject": {"type": "string", "example": "string", "description": "Subject line of emails composed from this template. Supports merge-field placeholders."}, "type": {"type": "integer", "description": "Template format (e.g. HtmlTemplate, PlainTextTemplate).\n\nInteger enum value: 0 - TextTemplate, 1 - HtmlTemplate, 2 - WysiwygTemplate", "example": 0, "enum": [0, 1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sharing_units": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to EmailTemplateSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailTemplateSharingSalesUnitRelation' object for properties."}, "description": "Sales units granted shared access to this template (custom share mode)."}, "sharing_clients": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to EmailTemplateSharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailTemplateSharingClientRelation' object for properties."}, "description": "Users granted shared access to this template (custom share mode)."}, "documents": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties."}, "description": "Files attached to the template (used as default attachments)."}}, "required": ["is_delete_protected", "id", "owner", "name", "owner_id", "subject", "type"]}, "createEmailTemplateInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "body": {"type": "string", "example": "string", "description": "HTML body of the template. May use merge-field placeholders that are filled with record values when the template is composed."}, "email_template_folder_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the folder."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the template owner."}, "recent_colors": {"type": "object", "description": "List of integers."}, "share_mode": {"type": "integer", "description": "Sharing model for the template (e.g. shared with selected sales units, selected users, or open for editing by all).\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "sharing_url_is_enabled": {"type": "boolean", "example": false, "description": "When true, the template's public sharing URL is active and accessible. Setting to false invalidates outstanding sharing URLs."}, "sharing_url_settings": {"type": "object", "description": "Public sharing-link configuration: resolved URL plus optional personalisation context (entity type, entity id) used to pre-fill merge fields. Empty when no sharing link is configured."}, "subject": {"type": "string", "example": "string", "description": "Subject line of emails composed from this template. Supports merge-field placeholders."}, "type": {"type": "integer", "description": "Template format (e.g. HtmlTemplate, PlainTextTemplate).\n\nInteger enum value: 0 - TextTemplate, 1 - HtmlTemplate, 2 - WysiwygTemplate", "example": 0, "enum": [0, 1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to EmailTemplateSharingSalesUnitRelation, see: 'createEmailTemplateSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units granted shared access to this template (custom share mode)."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to EmailTemplateSharingClientRelation, see: 'createEmailTemplateSharingClientRelationInput' object for properties."}, "description": "Users granted shared access to this template (custom share mode)."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties."}, "description": "Files attached to the template (used as default attachments)."}}, "required": ["name", "owner_id", "subject", "type"]}, "updateEmailTemplateInput": {"properties": {"body": {"type": "string", "example": "string", "description": "HTML body of the template. May use merge-field placeholders that are filled with record values when the template is composed."}, "email_template_folder_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the folder."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the template owner."}, "recent_colors": {"type": "object", "description": "List of integers."}, "share_mode": {"type": "integer", "description": "Sharing model for the template (e.g. shared with selected sales units, selected users, or open for editing by all).\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "sharing_url_is_enabled": {"type": "boolean", "example": false, "description": "When true, the template's public sharing URL is active and accessible. Setting to false invalidates outstanding sharing URLs."}, "sharing_url_settings": {"type": "object", "description": "Public sharing-link configuration: resolved URL plus optional personalisation context (entity type, entity id) used to pre-fill merge fields. Empty when no sharing link is configured."}, "subject": {"type": "string", "example": "string", "description": "Subject line of emails composed from this template. Supports merge-field placeholders."}, "type": {"type": "integer", "description": "Template format (e.g. HtmlTemplate, PlainTextTemplate).\n\nInteger enum value: 0 - TextTemplate, 1 - HtmlTemplate, 2 - WysiwygTemplate", "example": 0, "enum": [0, 1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to EmailTemplateSharingSalesUnitRelation, see: 'updateEmailTemplateSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units granted shared access to this template (custom share mode)."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to EmailTemplateSharingClientRelation, see: 'updateEmailTemplateSharingClientRelationInput' object for properties."}, "description": "Users granted shared access to this template (custom share mode)."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Files attached to the template (used as default attachments)."}}}, "batchEmailTemplateInput": {"properties": {"body": {"type": "string", "example": "string", "description": "HTML body of the template. May use merge-field placeholders that are filled with record values when the template is composed."}, "email_template_folder_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the folder."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the template owner."}, "recent_colors": {"type": "object", "description": "List of integers."}, "share_mode": {"type": "integer", "description": "Sharing model for the template (e.g. shared with selected sales units, selected users, or open for editing by all).\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "sharing_url_is_enabled": {"type": "boolean", "example": false, "description": "When true, the template's public sharing URL is active and accessible. Setting to false invalidates outstanding sharing URLs."}, "sharing_url_settings": {"type": "object", "description": "Public sharing-link configuration: resolved URL plus optional personalisation context (entity type, entity id) used to pre-fill merge fields. Empty when no sharing link is configured."}, "subject": {"type": "string", "example": "string", "description": "Subject line of emails composed from this template. Supports merge-field placeholders."}, "type": {"type": "integer", "description": "Template format (e.g. HtmlTemplate, PlainTextTemplate).\n\nInteger enum value: 0 - TextTemplate, 1 - HtmlTemplate, 2 - WysiwygTemplate", "example": 0, "enum": [0, 1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to EmailTemplateSharingSalesUnitRelation, see: 'updateEmailTemplateSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units granted shared access to this template (custom share mode)."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to EmailTemplateSharingClientRelation, see: 'updateEmailTemplateSharingClientRelationInput' object for properties."}, "description": "Users granted shared access to this template (custom share mode)."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Files attached to the template (used as default attachments)."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "EmailTemplateFolder": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "parent_email_template_folder": {"type": "string", "format": "uri", "description": "Parent folder in the template hierarchy. Empty for top-level folders.\n\nRelation to EmailTemplateFolder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailTemplateFolder' object for properties."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "parent_email_template_folder_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent folder."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "name"]}, "createEmailTemplateFolderInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "parent_email_template_folder_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent folder."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["name"]}, "updateEmailTemplateFolderInput": {"properties": {"name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "parent_email_template_folder_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent folder."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchEmailTemplateFolderInput": {"properties": {"name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "parent_email_template_folder_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent folder."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "EmailTemplateSharingClientRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client": {"type": "string", "format": "uri", "description": "User the template is shared with.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "email_template": {"type": "string", "format": "uri", "description": "Email template being shared.\n\nRelation to EmailTemplate. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailTemplate' object for properties."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "email_template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email template."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the template.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "client", "email_template", "client_id", "email_template_id"]}, "createEmailTemplateSharingClientRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "email_template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email template."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the template.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["client_id", "email_template_id"]}, "updateEmailTemplateSharingClientRelationInput": {"properties": {"client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "email_template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email template."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the template.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchEmailTemplateSharingClientRelationInput": {"properties": {"client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "email_template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email template."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the template.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "EmailTemplateSharingSalesUnitRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "email_template": {"type": "string", "format": "uri", "description": "Email template being shared.\n\nRelation to EmailTemplate. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailTemplate' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit the template is shared with.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "email_template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email template."}, "role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the template.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "email_template", "unit", "email_template_id", "unit_id"]}, "createEmailTemplateSharingSalesUnitRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "email_template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email template."}, "role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the template.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["email_template_id", "unit_id"]}, "updateEmailTemplateSharingSalesUnitRelationInput": {"properties": {"email_template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email template."}, "role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the template.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchEmailTemplateSharingSalesUnitRelationInput": {"properties": {"email_template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email template."}, "role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the template.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "EmailThreadMailboxClientReadState": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client": {"type": "string", "format": "uri", "description": "User whose read state of the email thread is tracked.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user whose read state of the email thread is tracked."}, "last_read_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Time when the user last read the email thread in the mailbox."}, "mailbox_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the mailbox (connected email account) the email thread belongs to."}, "thread_or_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email thread, or the id of the email itself when it does not belong to a thread."}}, "required": ["is_delete_protected", "id", "client", "client_id", "mailbox_id", "thread_or_id"]}, "createEmailThreadMailboxClientReadStateInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user whose read state of the email thread is tracked."}, "last_read_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Time when the user last read the email thread in the mailbox."}, "mailbox_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the mailbox (connected email account) the email thread belongs to."}, "thread_or_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email thread, or the id of the email itself when it does not belong to a thread."}}, "required": ["client_id", "mailbox_id", "thread_or_id"]}, "updateEmailThreadMailboxClientReadStateInput": {"properties": {"client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user whose read state of the email thread is tracked."}, "last_read_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Time when the user last read the email thread in the mailbox."}, "mailbox_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the mailbox (connected email account) the email thread belongs to."}, "thread_or_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email thread, or the id of the email itself when it does not belong to a thread."}}}, "batchEmailThreadMailboxClientReadStateInput": {"properties": {"client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user whose read state of the email thread is tracked."}, "last_read_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Time when the user last read the email thread in the mailbox."}, "mailbox_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the mailbox (connected email account) the email thread belongs to."}, "thread_or_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email thread, or the id of the email itself when it does not belong to a thread."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Entity": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "entity_name": {"type": "string", "example": "string", "description": "Stable identifier of the entity (e.g. \"Account\", \"Lead\", \"Opportunity\").", "readOnly": true}, "table_name": {"type": "string", "example": "string", "description": "Internal storage identifier for the entity. Read-only.", "readOnly": true}, "table_ex": {"type": "string", "example": "string", "description": "Internal storage identifier for the entity's custom-field data. Read-only.", "readOnly": true}, "table_data_ex": {"type": "string", "example": "string", "description": "Internal storage identifier for the entity's data relation rows. Read-only.", "readOnly": true}, "default_view_field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the field used as the default display label for records of this entity.", "readOnly": true}, "abstract_entity_id": {"type": "string", "example": "string", "description": "For sub-entities (e.g. Lead/Opportunity sharing a LeadOppty parent), the entity name of the parent abstract entity. Empty for stand-alone entities.", "readOnly": true}, "entity_type": {"type": "integer", "format": "int32", "example": 1, "description": "Kind of the entity in the platform: business entity, system schema, custom entity, etc.", "readOnly": true}, "preference_order": {"type": "integer", "format": "int32", "example": 1, "description": "Display order used to sort entities in pickers and navigation lists; lower values appear first.", "readOnly": true}, "allows_multiple_relation": {"type": "boolean", "example": false, "description": "True when records of this entity can be linked to multiple records of the same other entity through the same relation.", "readOnly": true}, "has_draft": {"type": "boolean", "example": false, "description": "True when records of this entity support drafts (changes go through a draft before being published).", "readOnly": true}, "access_mode": {"type": "integer", "format": "int32", "example": 1, "description": "Access scope of records of this entity: shared across the entire space, scoped to a sales unit, or owner-only.", "readOnly": true}, "icon": {"type": "integer", "format": "int32", "example": 1, "description": "Numeric icon identifier used to render the entity in the UI.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "True when the entity is marked as deleted (soft-delete). Read-only at the entity-metadata level.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "settings": {"type": "object", "description": "Optional space-level configuration for the entity (e.g. UI/feature flags). Empty when no overrides are set."}, "name_singular": {"type": "string", "example": "string", "description": "Display name of the entity in singular form (e.g. \"Account\")."}, "name_plural": {"type": "string", "example": "string", "description": "Display name of the entity in plural form (e.g. \"Accounts\")."}}, "required": ["is_delete_protected", "id", "default_view_field_id", "abstract_entity_id", "entity_type", "preference_order", "has_draft", "access_mode", "icon"]}, "EntityFitness": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "lead_type": {"type": "string", "format": "uri", "description": "Lead type this fitness configuration applies to. Set when configuring fitness for leads.\n\nRelation to LeadType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadType' object for properties."}, "oppty_type": {"type": "string", "format": "uri", "description": "Opportunity type this fitness configuration applies to. Set when configuring fitness for opportunities.\n\nRelation to OpportunityType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpportunityType' object for properties."}, "lead_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead type."}, "oppty_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "indicator_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to EntityFitnessIndicator. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EntityFitnessIndicator' object for properties."}, "description": "Fitness indicators (system or custom rules) defined for this configuration."}, "entity_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity type this fitness configuration applies to."}, "entity_type": {"type": "integer", "description": "Entity kind this fitness configuration applies to (Lead or Opportunity). Derived from whichever of lead_type/oppty_type is set.\n\nInteger enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]}}, "required": ["is_delete_protected", "id", "entity_type_id", "entity_type"]}, "createEntityFitnessInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "indicator_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to EntityFitnessIndicator, see: 'createEntityFitnessIndicatorInput' object for properties."}, "description": "Fitness indicators (system or custom rules) defined for this configuration."}}}, "updateEntityFitnessInput": {"properties": {"revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "indicator_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to EntityFitnessIndicator, see: 'updateEntityFitnessIndicatorInput' object for properties."}, "description": "Fitness indicators (system or custom rules) defined for this configuration."}}}, "batchEntityFitnessInput": {"properties": {"revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "indicator_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to EntityFitnessIndicator, see: 'updateEntityFitnessIndicatorInput' object for properties."}, "description": "Fitness indicators (system or custom rules) defined for this configuration."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "EntityFitnessIndicator": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "entity_fitness": {"type": "string", "format": "uri", "description": "Fitness configuration this indicator belongs to.\n\nRelation to EntityFitness. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EntityFitness' object for properties."}, "description": {"type": "string", "example": "string", "description": "Description of what the indicator measures, shown in the UI."}, "description_use_lang": {"type": "boolean", "example": false, "description": "When true, description is treated as a translation key and localized in the UI."}, "entity_fitness_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the fitness configuration."}, "how_to_fix": {"type": "string", "example": "string", "description": "Suggested remediation text shown to the user when a record triggers this indicator."}, "how_to_fix_use_lang": {"type": "boolean", "example": false, "description": "When true, how_to_fix is treated as a translation key and localized in the UI."}, "is_enabled": {"type": "boolean", "example": false, "description": "When false, the indicator is configured but not evaluated for records."}, "name": {"type": "string", "example": "string", "description": "Display name of the indicator."}, "name_use_lang": {"type": "boolean", "example": false, "description": "When true, name is treated as a translation key and localized in the UI; otherwise the literal text is shown."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Indicator rules. For system indicators contains three thresholds (Notice, Warning, Error); for custom indicators contains user-defined filter rules."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Custom, 2 - LowEmailOutreach, 3 - LowEmailEngagement, 4 - TasksOverdue, 5 - NoFollowUp, 6 - ClosingDateOverdue, 7 - SalesStepVelocityOverdue, 8 - SalesCycleOverdue, 9 - ManyClosingDateUpdates, 10 - MovedToPreviousStep, 11 - RankingDecrease, 12 - ValueDecrease", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "entity_fitness", "description", "description_use_lang", "entity_fitness_id", "how_to_fix", "how_to_fix_use_lang", "is_enabled", "name", "name_use_lang", "settings", "type"]}, "createEntityFitnessIndicatorInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "description": {"type": "string", "example": "string", "description": "Description of what the indicator measures, shown in the UI."}, "description_use_lang": {"type": "boolean", "example": false, "description": "When true, description is treated as a translation key and localized in the UI."}, "entity_fitness_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the fitness configuration."}, "how_to_fix": {"type": "string", "example": "string", "description": "Suggested remediation text shown to the user when a record triggers this indicator."}, "how_to_fix_use_lang": {"type": "boolean", "example": false, "description": "When true, how_to_fix is treated as a translation key and localized in the UI."}, "is_enabled": {"type": "boolean", "example": false, "description": "When false, the indicator is configured but not evaluated for records."}, "name": {"type": "string", "example": "string", "description": "Display name of the indicator."}, "name_use_lang": {"type": "boolean", "example": false, "description": "When true, name is treated as a translation key and localized in the UI; otherwise the literal text is shown."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Indicator rules. For system indicators contains three thresholds (Notice, Warning, Error); for custom indicators contains user-defined filter rules."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Custom, 2 - LowEmailOutreach, 3 - LowEmailEngagement, 4 - TasksOverdue, 5 - NoFollowUp, 6 - ClosingDateOverdue, 7 - SalesStepVelocityOverdue, 8 - SalesCycleOverdue, 9 - ManyClosingDateUpdates, 10 - MovedToPreviousStep, 11 - RankingDecrease, 12 - ValueDecrease", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["description", "description_use_lang", "entity_fitness_id", "how_to_fix", "how_to_fix_use_lang", "is_enabled", "name", "name_use_lang", "settings", "type"]}, "updateEntityFitnessIndicatorInput": {"properties": {"description": {"type": "string", "example": "string", "description": "Description of what the indicator measures, shown in the UI."}, "description_use_lang": {"type": "boolean", "example": false, "description": "When true, description is treated as a translation key and localized in the UI."}, "entity_fitness_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the fitness configuration."}, "how_to_fix": {"type": "string", "example": "string", "description": "Suggested remediation text shown to the user when a record triggers this indicator."}, "how_to_fix_use_lang": {"type": "boolean", "example": false, "description": "When true, how_to_fix is treated as a translation key and localized in the UI."}, "is_enabled": {"type": "boolean", "example": false, "description": "When false, the indicator is configured but not evaluated for records."}, "name": {"type": "string", "example": "string", "description": "Display name of the indicator."}, "name_use_lang": {"type": "boolean", "example": false, "description": "When true, name is treated as a translation key and localized in the UI; otherwise the literal text is shown."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Indicator rules. For system indicators contains three thresholds (Notice, Warning, Error); for custom indicators contains user-defined filter rules."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Custom, 2 - LowEmailOutreach, 3 - LowEmailEngagement, 4 - TasksOverdue, 5 - NoFollowUp, 6 - ClosingDateOverdue, 7 - SalesStepVelocityOverdue, 8 - SalesCycleOverdue, 9 - ManyClosingDateUpdates, 10 - MovedToPreviousStep, 11 - RankingDecrease, 12 - ValueDecrease", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchEntityFitnessIndicatorInput": {"properties": {"description": {"type": "string", "example": "string", "description": "Description of what the indicator measures, shown in the UI."}, "description_use_lang": {"type": "boolean", "example": false, "description": "When true, description is treated as a translation key and localized in the UI."}, "entity_fitness_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the fitness configuration."}, "how_to_fix": {"type": "string", "example": "string", "description": "Suggested remediation text shown to the user when a record triggers this indicator."}, "how_to_fix_use_lang": {"type": "boolean", "example": false, "description": "When true, how_to_fix is treated as a translation key and localized in the UI."}, "is_enabled": {"type": "boolean", "example": false, "description": "When false, the indicator is configured but not evaluated for records."}, "name": {"type": "string", "example": "string", "description": "Display name of the indicator."}, "name_use_lang": {"type": "boolean", "example": false, "description": "When true, name is treated as a translation key and localized in the UI; otherwise the literal text is shown."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Indicator rules. For system indicators contains three thresholds (Notice, Warning, Error); for custom indicators contains user-defined filter rules."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Custom, 2 - LowEmailOutreach, 3 - LowEmailEngagement, 4 - TasksOverdue, 5 - NoFollowUp, 6 - ClosingDateOverdue, 7 - SalesStepVelocityOverdue, 8 - SalesCycleOverdue, 9 - ManyClosingDateUpdates, 10 - MovedToPreviousStep, 11 - RankingDecrease, 12 - ValueDecrease", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "EntityHealth": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "type": {"type": "string", "format": "uri", "description": "Account type this health configuration applies to.\n\nRelation to AccountType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountType' object for properties."}, "entity_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]}, "is_enabled": {"type": "boolean", "example": false, "description": "When false, health is configured but not evaluated for records of this type."}, "last_recalculation": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the last full health recalculation across all matching records."}, "type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Health configuration: indicator filter definitions for healthy and critical-health states. Stored as a versioned JSON document; updates create a new history entry."}, "calculation_progress": {"type": "integer", "format": "int32", "example": 1, "description": "Progress of the in-flight health recalculation as a percentage (0-100). Null when no recalculation has been queued."}}, "required": ["is_delete_protected", "id", "type", "entity_type", "is_enabled", "type_id", "settings"]}, "createEntityHealthInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "is_enabled": {"type": "boolean", "example": false, "description": "When false, health is configured but not evaluated for records of this type."}, "last_recalculation": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the last full health recalculation across all matching records."}, "type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_enabled", "type_id"]}, "updateEntityHealthInput": {"properties": {"is_enabled": {"type": "boolean", "example": false, "description": "When false, health is configured but not evaluated for records of this type."}, "last_recalculation": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the last full health recalculation across all matching records."}, "type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Health configuration: indicator filter definitions for healthy and critical-health states. Stored as a versioned JSON document; updates create a new history entry."}}}, "batchEntityHealthInput": {"properties": {"is_enabled": {"type": "boolean", "example": false, "description": "When false, health is configured but not evaluated for records of this type."}, "last_recalculation": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the last full health recalculation across all matching records."}, "type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Health configuration: indicator filter definitions for healthy and critical-health states. Stored as a versioned JSON document; updates create a new history entry."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "EntityScoring": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "entity_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]}, "is_enabled": {"type": "boolean", "example": false, "description": "When false, the scoring configuration is defined but not evaluated for records."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "object", "description": "Entity scoring definition in json format."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of this scoring configuration among others for the same entity type. Configurations are evaluated in this order until one matches."}, "use_lang": {"type": "boolean", "example": false, "description": "When true, the configuration name is treated as a translation key and localized in the UI; otherwise the literal name is shown."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "entity_type", "is_enabled", "name", "settings", "sort_order"]}, "createEntityScoringInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "entity_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]}, "is_enabled": {"type": "boolean", "example": false, "description": "When false, the scoring configuration is defined but not evaluated for records."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "object", "description": "Entity scoring definition in json format."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of this scoring configuration among others for the same entity type. Configurations are evaluated in this order until one matches."}, "use_lang": {"type": "boolean", "example": false, "description": "When true, the configuration name is treated as a translation key and localized in the UI; otherwise the literal name is shown."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["entity_type", "is_enabled", "name", "settings", "sort_order"]}, "updateEntityScoringInput": {"properties": {"is_enabled": {"type": "boolean", "example": false, "description": "When false, the scoring configuration is defined but not evaluated for records."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "object", "description": "Entity scoring definition in json format."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of this scoring configuration among others for the same entity type. Configurations are evaluated in this order until one matches."}, "use_lang": {"type": "boolean", "example": false, "description": "When true, the configuration name is treated as a translation key and localized in the UI; otherwise the literal name is shown."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchEntityScoringInput": {"properties": {"is_enabled": {"type": "boolean", "example": false, "description": "When false, the scoring configuration is defined but not evaluated for records."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "object", "description": "Entity scoring definition in json format."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of this scoring configuration among others for the same entity type. Configurations are evaluated in this order until one matches."}, "use_lang": {"type": "boolean", "example": false, "description": "When true, the configuration name is treated as a translation key and localized in the UI; otherwise the literal name is shown."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "EntitySettings": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "has_draft": {"type": "boolean", "example": false, "description": "Set to True if draft for entity exists and can be published"}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "default_list_columns": {"type": "string", "format": "binary", "example": "blob", "description": "Default column configuration applied to list views of this entity (which fields are shown, their widths, frozen state, and whether to push the configuration to existing users)."}, "is_published": {"type": "boolean", "example": false, "description": "True when the settings are published; false while they exist only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "has_draft", "id", "default_list_columns"]}, "createEntitySettingsInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "default_list_columns": {"type": "string", "format": "binary", "example": "blob", "description": "Default column configuration applied to list views of this entity (which fields are shown, their widths, frozen state, and whether to push the configuration to existing users)."}, "is_published": {"type": "boolean", "example": false, "description": "True when the settings are published; false while they exist only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["default_list_columns"]}, "updateEntitySettingsInput": {"properties": {"default_list_columns": {"type": "string", "format": "binary", "example": "blob", "description": "Default column configuration applied to list views of this entity (which fields are shown, their widths, frozen state, and whether to push the configuration to existing users)."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchEntitySettingsInput": {"properties": {"default_list_columns": {"type": "string", "format": "binary", "example": "blob", "description": "Default column configuration applied to list views of this entity (which fields are shown, their widths, frozen state, and whether to push the configuration to existing users)."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Field": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "has_draft": {"type": "boolean", "example": false, "description": "Set to True if draft for entity exists and can be published"}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "True when the field is marked as deleted (soft-delete)."}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "entity_name": {"type": "string", "example": "string", "description": "Related entity name for field (e.g. Account, Contact, Lead, Opportunity, ...)", "readOnly": true}, "api_name": {"type": "string", "example": "string", "description": "Immutable and generated name. This name is used for integrations."}, "name": {"type": "string", "example": "string", "description": "User friendly name for field."}, "use_lang": {"type": "integer", "format": "int32", "example": 1, "description": "When true, the field name is treated as a translation key and resolved through the translation system; otherwise the literal name is shown."}, "column_name": {"type": "string", "example": "string", "description": "Storage column name for the field; used as the filter key in API queries."}, "column_source": {"type": "integer", "format": "int32", "example": 1, "description": "Storage origin of the field: on the main entity record, on the custom-field data record, or computed.", "readOnly": true}, "relation_id": {"type": "string", "example": "string", "description": "For relation-typed fields, identifier of the relation kind that connects this entity to the related entity. Empty for non-relation fields."}, "relation_with_entity_id": {"type": "string", "example": "string", "description": "For relation-typed fields, the entity the field points to (e.g. Contact, Account). Empty for non-relation fields."}, "shared_with_field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "When the field is shared between abstract entities (e.g. Lead and Opportunity), id of the counterpart field on the other entity. Empty when the field is not shared."}, "system_type": {"type": "integer", "format": "int32", "example": 1, "description": "Whether the field is System (built-in, immutable), Protected (built-in, limited changes), or Custom (user-created).", "readOnly": true}, "type_id": {"type": "string", "example": "string", "description": "Type of the field. Supported field types are: checkbox, currency, currency_foreign, date, datetime, dropdown, email, float, input, integer, multiselect_checkbox, phone, radio, sequence, text_area, url"}, "composite_field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "For sub-fields of a composite field (e.g. the value/currency parts of a foreign currency field), id of the parent composite field. Empty for top-level fields."}, "data_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Optional custom data set id can be set."}, "parent_options_field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "For dependent dropdown/radio fields, id of the parent field whose selected value restricts the options shown on this field."}, "calc_formula": {"type": "string", "example": "string", "description": "Calculated formula used for fields which supports calculation."}, "default_value": {"type": "string", "example": "string", "description": "A default value for field."}, "sequence_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "For sequence-typed fields, id grouping the FieldSequence rows that drive auto-numbering for this field."}, "sequence_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Deprecated; always returns null. Use sequence_set_id and FieldSequence instead."}, "system_required": {"type": "boolean", "example": false, "description": "True when the field cannot be made optional (enforced by the platform).", "readOnly": true}, "is_published": {"type": "boolean", "example": false, "description": "True when the field configuration is published; false while the field exists only as an unpublished draft.", "readOnly": true}, "system_readonly": {"type": "boolean", "example": false, "description": "True when the field cannot be made writable (enforced by the platform).", "readOnly": true}, "use_in_global_search": {"type": "boolean", "example": false, "description": "If this field is allowed in global search."}, "settings": {"type": "object", "description": "Type-specific configuration for the field (e.g. rollup definition, calculated formula, AI options). Shape depends on type_id; null for fields that need no extra configuration."}, "is_unique": {"type": "boolean", "example": false, "description": "If true, then there will be an API validation if value of entity is unique.", "readOnly": true}, "data_set": {"type": "string", "format": "uri", "description": "For dropdown, radio, and multiselect-checkbox fields, the set of available options. Empty for other field types.\n\nRelation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties."}, "lookup": {"type": "object", "description": "Lookup field definition."}, "sequence_pattern": {"type": "string", "example": "string", "description": "Deprecated - previously returned sequence pattern used for sequence type of field."}, "sequence": {"type": "object", "description": "Sequence field definition."}, "rollup": {"type": "object", "description": "Rollup field definition."}, "options": {"type": "object", "description": "Available option values for dropdown, radio, and multiselect-checkbox fields, including labels and translations. Empty for other field types."}, "ai_options": {"type": "object", "description": "AI Smart Field options. Available for input, text_area, integer, float, email, phone, url, currency."}, "advanced_formula": {"type": "object", "description": "Advanced calculated formula"}, "source_field_id": {"type": "string", "example": "string", "description": "For derived fields, id of the underlying source field that drives this field's value (e.g. the value side of a composite currency field)."}, "source_type_id": {"type": "string", "example": "string", "description": "Underlying primitive type id of the field, after resolving composite/rollup/lookup wrappers."}, "use_in_interface_preview": {"type": "boolean", "example": false, "description": "True when the field can be used in the record interface preview pane."}, "translated_name": {"type": "string", "example": "string", "description": "Field name resolved into the current user's language. When use_lang is true, the name is looked up via the translation system; otherwise name is returned as-is."}, "field_permissions": {"type": "string", "format": "uri", "description": "Per-user-role access overrides for this field. Empty when the field uses default access (full access for all roles).\n\nRelation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties."}, "original_dataset_field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "When multiple dropdown/radio fields share a data set, id of the field that originally defined the data set. Null when this field is the originator or has no data set."}, "name_translations": {"type": "string", "format": "binary", "example": "blob", "description": "Map of locale codes to translated field names (e.g. {\"en-US\": \"First name\", \"de-DE\": \"Vorname\"}). Empty when no translations are defined."}, "name_translated": {"type": "string", "example": "string", "description": "Field name in the current user's language, taken from name_translations. Empty when no translation is available for that language."}, "primitive_type": {"type": "string", "example": "string", "description": "Primitive value type of the field (e.g. STRING, INT, BOOL, DATE, ENUM), derived from source_type_id."}, "is_readonly_on_recurrent_appointment": {"type": "boolean", "example": false, "description": "True when the field cannot be edited on individual occurrences of a recurring appointment (changes must be made on the recurrence master)."}, "is_available_for_webresource": {"type": "boolean", "example": false, "description": "True when the field can be referenced from a Webresource URL template."}, "is_available_for_advanced_formula": {"type": "boolean", "example": false, "description": "True when the field can be used as an input in an advanced calculated formula expression on this entity."}}, "required": ["is_delete_protected", "has_draft", "id", "entity_name", "name", "type_id", "data_set", "source_field_id", "source_type_id", "use_in_interface_preview", "translated_name", "field_permissions", "name_translations", "name_translated", "primitive_type", "is_readonly_on_recurrent_appointment", "is_available_for_webresource", "is_available_for_advanced_formula"]}, "createFieldInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "entity_name": {"type": "string", "example": "string", "description": "Related entity name for field (e.g. Account, Contact, Lead, Opportunity, ...)", "readOnly": true}, "name": {"type": "string", "example": "string", "description": "User friendly name for field."}, "type_id": {"type": "string", "example": "string", "description": "Type of the field. Supported field types are: checkbox, currency, currency_foreign, date, datetime, dropdown, email, float, input, integer, multiselect_checkbox, phone, radio, sequence, text_area, url"}, "data_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Optional custom data set id can be set."}, "parent_options_field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "For dependent dropdown/radio fields, id of the parent field whose selected value restricts the options shown on this field."}, "calc_formula": {"type": "string", "example": "string", "description": "Calculated formula used for fields which supports calculation."}, "default_value": {"type": "string", "example": "string", "description": "A default value for field."}, "is_unique": {"type": "boolean", "example": false, "description": "If true, then there will be an API validation if value of entity is unique.", "readOnly": true}, "name_translations": {"type": "string", "format": "binary", "example": "blob", "description": "Map of locale codes to translated field names (e.g. {\"en-US\": \"First name\", \"de-DE\": \"Vorname\"}). Empty when no translations are defined."}}, "required": ["entity_name", "name", "type_id", "name_translations"]}, "updateFieldInput": {"properties": {"name": {"type": "string", "example": "string", "description": "User friendly name for field."}, "parent_options_field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "For dependent dropdown/radio fields, id of the parent field whose selected value restricts the options shown on this field."}, "calc_formula": {"type": "string", "example": "string", "description": "Calculated formula used for fields which supports calculation."}, "default_value": {"type": "string", "example": "string", "description": "A default value for field."}, "name_translations": {"type": "string", "format": "binary", "example": "blob", "description": "Map of locale codes to translated field names (e.g. {\"en-US\": \"First name\", \"de-DE\": \"Vorname\"}). Empty when no translations are defined."}}}, "batchFieldInput": {"properties": {"name": {"type": "string", "example": "string", "description": "User friendly name for field."}, "parent_options_field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "For dependent dropdown/radio fields, id of the parent field whose selected value restricts the options shown on this field."}, "calc_formula": {"type": "string", "example": "string", "description": "Calculated formula used for fields which supports calculation."}, "default_value": {"type": "string", "example": "string", "description": "A default value for field."}, "name_translations": {"type": "string", "format": "binary", "example": "blob", "description": "Map of locale codes to translated field names (e.g. {\"en-US\": \"First name\", \"de-DE\": \"Vorname\"}). Empty when no translations are defined."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "FieldMapping": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "is_system": {"type": "boolean", "example": false, "description": "True when the mapping is shipped by the platform and cannot be deleted by the user."}, "mapping": {"type": "string", "format": "binary", "example": "blob", "description": "Default field-to-field mapping template applied when no per-type-pair mapping matches."}, "operation": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Default, 2 - Qualification, 3 - FollowUp, 4 - Parent, 5 - QualificationAndAutocreate, 6 - Conversion", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "source_entity_api_name": {"type": "string", "example": "string", "description": "API name of the source custom entity. Set only when source_entity_name is \"CustomEntity\"; otherwise empty."}, "target_entity_api_name": {"type": "string", "example": "string", "description": "API name of the target custom entity. Set only when target_entity_name is \"CustomEntity\"; otherwise empty."}, "type_mappings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type-pair field mappings: each entry binds a set of source/target type ids and the field-to-field mapping that applies when both types match."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "source_entity_name": {"type": "string", "example": "string", "description": "Source entity kind for the mapping (e.g. Lead, Account, Contact). Returns \"CustomEntity\" when the source is a custom entity; the API name is then exposed via source_entity_api_name."}, "target_entity_name": {"type": "string", "example": "string", "description": "Target entity kind for the mapping (e.g. Lead, Account, Contact). Returns \"CustomEntity\" when the target is a custom entity; the API name is then exposed via target_entity_api_name."}, "documents": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties."}, "description": "Files attached to the mapping (e.g. import source files)."}}, "required": ["is_delete_protected", "id", "is_system", "source_entity_name", "target_entity_name"]}, "createFieldMappingInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "is_system": {"type": "boolean", "example": false, "description": "True when the mapping is shipped by the platform and cannot be deleted by the user."}, "mapping": {"type": "string", "format": "binary", "example": "blob", "description": "Default field-to-field mapping template applied when no per-type-pair mapping matches."}, "operation": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Default, 2 - Qualification, 3 - FollowUp, 4 - Parent, 5 - QualificationAndAutocreate, 6 - Conversion", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "type_mappings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type-pair field mappings: each entry binds a set of source/target type ids and the field-to-field mapping that applies when both types match."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties."}, "description": "Files attached to the mapping (e.g. import source files)."}}, "required": ["is_system"]}, "updateFieldMappingInput": {"properties": {"is_system": {"type": "boolean", "example": false, "description": "True when the mapping is shipped by the platform and cannot be deleted by the user."}, "mapping": {"type": "string", "format": "binary", "example": "blob", "description": "Default field-to-field mapping template applied when no per-type-pair mapping matches."}, "operation": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Default, 2 - Qualification, 3 - FollowUp, 4 - Parent, 5 - QualificationAndAutocreate, 6 - Conversion", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "type_mappings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type-pair field mappings: each entry binds a set of source/target type ids and the field-to-field mapping that applies when both types match."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Files attached to the mapping (e.g. import source files)."}}}, "batchFieldMappingInput": {"properties": {"is_system": {"type": "boolean", "example": false, "description": "True when the mapping is shipped by the platform and cannot be deleted by the user."}, "mapping": {"type": "string", "format": "binary", "example": "blob", "description": "Default field-to-field mapping template applied when no per-type-pair mapping matches."}, "operation": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Default, 2 - Qualification, 3 - FollowUp, 4 - Parent, 5 - QualificationAndAutocreate, 6 - Conversion", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "type_mappings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type-pair field mappings: each entry binds a set of source/target type ids and the field-to-field mapping that applies when both types match."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Files attached to the mapping (e.g. import source files)."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "FieldPermission": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "has_draft": {"type": "boolean", "example": false, "description": "Set to True if draft for entity exists and can be published"}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "field": {"type": "string", "format": "uri", "description": "Custom field this permission applies to.\n\nRelation to Field. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Field' object for properties."}, "master_right": {"type": "string", "format": "uri", "description": "User role granted (or restricted) on the field.\n\nRelation to MasterRight. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MasterRight' object for properties."}, "field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the custom field."}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "permission_level": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - FullAccess, 2 - Readonly, 3 - NoAccess", "example": 1, "enum": [1, 2, 3]}, "is_published": {"type": "boolean", "example": false, "description": "True when the permission override is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "has_draft", "id", "field", "master_right", "field_id", "master_right_id"]}, "createFieldPermissionInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the custom field."}, "master_right_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user role."}, "permission_level": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - FullAccess, 2 - Readonly, 3 - NoAccess", "example": 1, "enum": [1, 2, 3]}, "is_published": {"type": "boolean", "example": false, "description": "True when the permission override is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["field_id", "master_right_id"]}, "updateFieldPermissionInput": {"properties": {"permission_level": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - FullAccess, 2 - Readonly, 3 - NoAccess", "example": 1, "enum": [1, 2, 3]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchFieldPermissionInput": {"properties": {"permission_level": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - FullAccess, 2 - Readonly, 3 - NoAccess", "example": 1, "enum": [1, 2, 3]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "FieldSequence": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "has_draft": {"type": "boolean", "example": false, "description": "Set to True if draft for entity exists and can be published"}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "filter": {"type": "object", "description": "Optional filter restricting which records this sequence applies to. Empty means the sequence applies to all records."}, "pattern": {"type": "string", "example": "string", "description": "Pattern template used to generate auto-numbered values (e.g. \"{prefix}{year}-{####}\")."}, "sequence_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier grouping all sequences (across entity types) that share the same auto-numbering pattern."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of this sequence within its sequence set; sequences are evaluated in this order, the first whose filter matches is used."}, "is_published": {"type": "boolean", "example": false, "description": "True when the sequence is published; false while it exists only as an unpublished draft.", "readOnly": true}}, "required": ["is_delete_protected", "has_draft", "id", "pattern", "sequence_set_id"]}, "Forecast": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "field": {"type": "string", "format": "uri", "description": "Field whose value is summed when computing forecast amounts (typically a currency field on Opportunity).\n\nRelation to Field. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Field' object for properties.", "readOnly": true}, "owner": {"type": "string", "format": "uri", "description": "User who owns the forecast.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "pipeline": {"type": "string", "format": "uri", "description": "Pipeline whose opportunities the forecast aggregates.\n\nRelation to Pipeline. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Pipeline' object for properties.", "readOnly": true}, "description": {"type": "string", "example": "string", "description": "Free-text description shown alongside the forecast."}, "end_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Last date covered by the forecast period.", "readOnly": true}, "field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the aggregation field.", "readOnly": true}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "pipeline_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the pipeline.", "readOnly": true}, "settings": {"type": "object", "description": "Forecast configuration as a JSON object conforming to the BetterForecastSchema type: currency, period (year + quarter/month), breakdown levels (type), items and quotas, and column layout. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/betterforecastschema.doc.html"}, "share_mode": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "share_mode_params": {"type": "string", "example": 1, "enum": [1, 2], "description": "Bit flags fine-tuning sharing behavior (e.g. allow editing for shared users)."}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "First date covered by the forecast period.", "readOnly": true}, "type": {"type": "object", "description": "Order of forecast levels as a JSON array (e.g. [\"Units\", \"Users\"]). Each level adds a grouping dimension to the breakdown.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "shared_clients": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "description": "Users granted shared access to this forecast (custom share mode)."}, "shared_units": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "description": "Sales units granted shared access to this forecast (custom share mode)."}}, "required": ["is_delete_protected", "id", "field", "owner", "pipeline", "end_date", "field_id", "name", "owner_id", "pipeline_id", "settings", "start_date", "type", "shared_clients", "shared_units"]}, "createForecastInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "description": {"type": "string", "example": "string", "description": "Free-text description shown alongside the forecast."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "settings": {"type": "object", "description": "Forecast configuration as a JSON object conforming to the BetterForecastSchema type: currency, period (year + quarter/month), breakdown levels (type), items and quotas, and column layout. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/betterforecastschema.doc.html"}, "share_mode": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "share_mode_params": {"type": "string", "example": 1, "enum": [1, 2], "description": "Bit flags fine-tuning sharing behavior (e.g. allow editing for shared users)."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "shared_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to Client, see: 'createClientInput' object for properties."}, "description": "Users granted shared access to this forecast (custom share mode)."}, "shared_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to SalesUnit, see: 'createSalesUnitInput' object for properties."}, "description": "Sales units granted shared access to this forecast (custom share mode)."}}, "required": ["name", "owner_id", "settings", "shared_clients", "shared_units"]}, "updateForecastInput": {"properties": {"description": {"type": "string", "example": "string", "description": "Free-text description shown alongside the forecast."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "settings": {"type": "object", "description": "Forecast configuration as a JSON object conforming to the BetterForecastSchema type: currency, period (year + quarter/month), breakdown levels (type), items and quotas, and column layout. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/betterforecastschema.doc.html"}, "share_mode": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "share_mode_params": {"type": "string", "example": 1, "enum": [1, 2], "description": "Bit flags fine-tuning sharing behavior (e.g. allow editing for shared users)."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "shared_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to Client, see: 'updateClientInput' object for properties."}, "description": "Users granted shared access to this forecast (custom share mode)."}, "shared_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to SalesUnit, see: 'updateSalesUnitInput' object for properties."}, "description": "Sales units granted shared access to this forecast (custom share mode)."}}}, "batchForecastInput": {"properties": {"description": {"type": "string", "example": "string", "description": "Free-text description shown alongside the forecast."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "settings": {"type": "object", "description": "Forecast configuration as a JSON object conforming to the BetterForecastSchema type: currency, period (year + quarter/month), breakdown levels (type), items and quotas, and column layout. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/betterforecastschema.doc.html"}, "share_mode": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "share_mode_params": {"type": "string", "example": 1, "enum": [1, 2], "description": "Bit flags fine-tuning sharing behavior (e.g. allow editing for shared users)."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "shared_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to Client, see: 'updateClientInput' object for properties."}, "description": "Users granted shared access to this forecast (custom share mode)."}, "shared_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to SalesUnit, see: 'updateSalesUnitInput' object for properties."}, "description": "Sales units granted shared access to this forecast (custom share mode)."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "FormView": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_type": {"type": "string", "format": "uri", "description": "Account type the form view applies to. Set when the form view targets accounts.\n\nRelation to AccountType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountType' object for properties."}, "contact_type": {"type": "string", "format": "uri", "description": "Contact type the form view applies to. Set when the form view targets contacts.\n\nRelation to ContactType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactType' object for properties."}, "lead_type": {"type": "string", "format": "uri", "description": "Lead type the form view applies to. Set when the form view targets leads.\n\nRelation to LeadType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadType' object for properties."}, "oppty_type": {"type": "string", "format": "uri", "description": "Opportunity type the form view applies to. Set when the form view targets opportunities.\n\nRelation to OpportunityType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpportunityType' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "User who owns the form view.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "account_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account type."}, "contact_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact type."}, "hidden_item_ids": {"type": "object", "description": "Ids of fields and webresources hidden from the form for this view."}, "item_colors": {"type": "object", "description": "Per-item color overrides for fields and webresources in the form, keyed by item id."}, "lead_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead type."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "oppty_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity type."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "share_mode": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "use_lang": {"type": "boolean", "example": false, "description": "When true, the form view name is treated as a translation key and localized in the UI; otherwise the literal name is shown."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "entity_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the type the form view is configured for, derived from whichever of the per-entity-type relations is set."}, "sharing_units": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to FormViewSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'FormViewSharingSalesUnitRelation' object for properties."}, "description": "Sales units that have been granted shared access to this form view (custom share mode)."}, "sharing_clients": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to FormViewSharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'FormViewSharingClientRelation' object for properties."}, "description": "Users that have been granted shared access to this form view (custom share mode)."}}, "required": ["is_delete_protected", "id", "owner", "hidden_item_ids", "item_colors", "name", "owner_id", "entity_type_id"]}, "createFormViewInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account type."}, "contact_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact type."}, "hidden_item_ids": {"type": "object", "description": "Ids of fields and webresources hidden from the form for this view."}, "item_colors": {"type": "object", "description": "Per-item color overrides for fields and webresources in the form, keyed by item id."}, "lead_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead type."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "oppty_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity type."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "share_mode": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "use_lang": {"type": "boolean", "example": false, "description": "When true, the form view name is treated as a translation key and localized in the UI; otherwise the literal name is shown."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to FormViewSharingSalesUnitRelation, see: 'createFormViewSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this form view (custom share mode)."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to FormViewSharingClientRelation, see: 'createFormViewSharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this form view (custom share mode)."}}, "required": ["hidden_item_ids", "item_colors", "name", "owner_id"]}, "updateFormViewInput": {"properties": {"account_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account type."}, "contact_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact type."}, "hidden_item_ids": {"type": "object", "description": "Ids of fields and webresources hidden from the form for this view."}, "item_colors": {"type": "object", "description": "Per-item color overrides for fields and webresources in the form, keyed by item id."}, "lead_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead type."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "oppty_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity type."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "share_mode": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "use_lang": {"type": "boolean", "example": false, "description": "When true, the form view name is treated as a translation key and localized in the UI; otherwise the literal name is shown."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to FormViewSharingSalesUnitRelation, see: 'updateFormViewSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this form view (custom share mode)."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to FormViewSharingClientRelation, see: 'updateFormViewSharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this form view (custom share mode)."}}}, "batchFormViewInput": {"properties": {"account_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account type."}, "contact_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact type."}, "hidden_item_ids": {"type": "object", "description": "Ids of fields and webresources hidden from the form for this view."}, "item_colors": {"type": "object", "description": "Per-item color overrides for fields and webresources in the form, keyed by item id."}, "lead_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead type."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "oppty_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity type."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "share_mode": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "use_lang": {"type": "boolean", "example": false, "description": "When true, the form view name is treated as a translation key and localized in the UI; otherwise the literal name is shown."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to FormViewSharingSalesUnitRelation, see: 'updateFormViewSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this form view (custom share mode)."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to FormViewSharingClientRelation, see: 'updateFormViewSharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this form view (custom share mode)."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "FormViewSharingClientRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client": {"type": "string", "format": "uri", "description": "User granted shared access to the form view.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "form_view": {"type": "string", "format": "uri", "description": "Form view being shared.\n\nRelation to FormView. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'FormView' object for properties."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "form_view_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared form view."}, "role": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "client", "form_view", "client_id", "form_view_id"]}, "createFormViewSharingClientRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "form_view_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared form view."}, "role": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["client_id", "form_view_id"]}, "updateFormViewSharingClientRelationInput": {"properties": {"client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "form_view_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared form view."}, "role": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchFormViewSharingClientRelationInput": {"properties": {"client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "form_view_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared form view."}, "role": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "FormViewSharingSalesUnitRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "form_view": {"type": "string", "format": "uri", "description": "Form view being shared.\n\nRelation to FormView. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'FormView' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit granted shared access to the form view.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "form_view_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared form view."}, "role": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "form_view", "unit", "form_view_id", "unit_id"]}, "createFormViewSharingSalesUnitRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "form_view_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared form view."}, "role": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["form_view_id", "unit_id"]}, "updateFormViewSharingSalesUnitRelationInput": {"properties": {"form_view_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared form view."}, "role": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchFormViewSharingSalesUnitRelationInput": {"properties": {"form_view_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared form view."}, "role": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "GhostContact": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "position": {"type": "string", "example": "string", "description": "Job title or position of the placeholder contact (org-chart label)."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "name"]}, "createGhostContactInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "position": {"type": "string", "example": "string", "description": "Job title or position of the placeholder contact (org-chart label)."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["name"]}, "updateGhostContactInput": {"properties": {"name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "position": {"type": "string", "example": "string", "description": "Job title or position of the placeholder contact (org-chart label)."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchGhostContactInput": {"properties": {"name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "position": {"type": "string", "example": "string", "description": "Job title or position of the placeholder contact (org-chart label)."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "GhostContactAccountAccountRoleRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_role": {"type": "string", "format": "uri", "description": "Account role assigned to the ghost contact.\n\nRelation to AccountRole. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountRole' object for properties."}, "ghost_contact_account_relation": {"type": "string", "format": "uri", "description": "Ghost-contact-on-account placement this role assignment belongs to.\n\nRelation to GhostContactAccountRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'GhostContactAccountRelation' object for properties."}, "account_role_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account role."}, "ghost_contact_account_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the ghost-contact-account placement."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "account_role", "ghost_contact_account_relation", "account_role_id", "ghost_contact_account_relation_id"]}, "createGhostContactAccountAccountRoleRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "ghost_contact_account_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Ghost-contact-on-account placement this role assignment belongs to.\n\nRelation to GhostContactAccountRelation, see: 'createGhostContactAccountRelationInput' object for properties."}, "account_role_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account role."}, "ghost_contact_account_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the ghost-contact-account placement."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["ghost_contact_account_relation", "account_role_id", "ghost_contact_account_relation_id"]}, "updateGhostContactAccountAccountRoleRelationInput": {"properties": {"ghost_contact_account_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Ghost-contact-on-account placement this role assignment belongs to.\n\nRelation to GhostContactAccountRelation, see: 'updateGhostContactAccountRelationInput' object for properties."}, "account_role_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account role."}, "ghost_contact_account_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the ghost-contact-account placement."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchGhostContactAccountAccountRoleRelationInput": {"properties": {"ghost_contact_account_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Ghost-contact-on-account placement this role assignment belongs to.\n\nRelation to GhostContactAccountRelation, see: 'updateGhostContactAccountRelationInput' object for properties."}, "account_role_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account role."}, "ghost_contact_account_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the ghost-contact-account placement."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "GhostContactAccountRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account": {"type": "string", "format": "uri", "description": "Account whose org chart includes the ghost contact.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "ghost_contact": {"type": "string", "format": "uri", "description": "Placeholder ghost contact placed on the account org chart.\n\nRelation to GhostContact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'GhostContact' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "comment": {"type": "string", "example": "string", "description": "Free-text comment shown on the org-chart node."}, "ghost_contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the ghost contact."}, "is_assistant": {"type": "boolean", "example": false, "description": "True when the ghost contact is rendered as an assistant of its parent in the org chart."}, "is_sibling": {"type": "boolean", "example": false, "description": "True when the ghost contact is rendered as a sibling rather than a child in the org chart."}, "position": {"type": "string", "example": "string", "description": "Position label shown on the org chart for the ghost contact."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "account_roles": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to GhostContactAccountAccountRoleRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'GhostContactAccountAccountRoleRelation' object for properties."}, "description": "Account roles assigned to the ghost contact on this account."}}, "required": ["is_delete_protected", "id", "account", "ghost_contact", "account_id", "ghost_contact_id"]}, "createGhostContactAccountRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "ghost_contact": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Placeholder ghost contact placed on the account org chart.\n\nRelation to GhostContact, see: 'createGhostContactInput' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "comment": {"type": "string", "example": "string", "description": "Free-text comment shown on the org-chart node."}, "ghost_contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the ghost contact."}, "is_assistant": {"type": "boolean", "example": false, "description": "True when the ghost contact is rendered as an assistant of its parent in the org chart."}, "is_sibling": {"type": "boolean", "example": false, "description": "True when the ghost contact is rendered as a sibling rather than a child in the org chart."}, "position": {"type": "string", "example": "string", "description": "Position label shown on the org chart for the ghost contact."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "account_roles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to GhostContactAccountAccountRoleRelation, see: 'createGhostContactAccountAccountRoleRelationInput' object for properties."}, "description": "Account roles assigned to the ghost contact on this account."}}, "required": ["ghost_contact", "account_id", "ghost_contact_id"]}, "updateGhostContactAccountRelationInput": {"properties": {"ghost_contact": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Placeholder ghost contact placed on the account org chart.\n\nRelation to GhostContact, see: 'updateGhostContactInput' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "comment": {"type": "string", "example": "string", "description": "Free-text comment shown on the org-chart node."}, "ghost_contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the ghost contact."}, "is_assistant": {"type": "boolean", "example": false, "description": "True when the ghost contact is rendered as an assistant of its parent in the org chart."}, "is_sibling": {"type": "boolean", "example": false, "description": "True when the ghost contact is rendered as a sibling rather than a child in the org chart."}, "position": {"type": "string", "example": "string", "description": "Position label shown on the org chart for the ghost contact."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "account_roles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to GhostContactAccountAccountRoleRelation, see: 'updateGhostContactAccountAccountRoleRelationInput' object for properties."}, "description": "Account roles assigned to the ghost contact on this account."}}}, "batchGhostContactAccountRelationInput": {"properties": {"ghost_contact": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Placeholder ghost contact placed on the account org chart.\n\nRelation to GhostContact, see: 'updateGhostContactInput' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "comment": {"type": "string", "example": "string", "description": "Free-text comment shown on the org-chart node."}, "ghost_contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the ghost contact."}, "is_assistant": {"type": "boolean", "example": false, "description": "True when the ghost contact is rendered as an assistant of its parent in the org chart."}, "is_sibling": {"type": "boolean", "example": false, "description": "True when the ghost contact is rendered as a sibling rather than a child in the org chart."}, "position": {"type": "string", "example": "string", "description": "Position label shown on the org chart for the ghost contact."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "account_roles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to GhostContactAccountAccountRoleRelation, see: 'updateGhostContactAccountAccountRoleRelationInput' object for properties."}, "description": "Account roles assigned to the ghost contact on this account."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "GhostLeadOpptyContactRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "ghost_contact": {"type": "string", "format": "uri", "description": "Placeholder ghost contact placed on the lead/opportunity org chart.\n\nRelation to GhostContact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'GhostContact' object for properties."}, "lead_oppty_contact_group_relation": {"type": "string", "format": "uri", "description": "Org-chart group the ghost contact belongs to, when grouped.\n\nRelation to LeadOpptyContactGroupRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadOpptyContactGroupRelation' object for properties."}, "lead": {"type": "string", "format": "uri", "description": "Lead whose org chart includes the ghost contact. Set when lead_oppty_id resolves to a Lead.\n\nRelation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties."}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity whose org chart includes the ghost contact. Set when lead_oppty_id resolves to an Opportunity.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "comment": {"type": "string", "example": "string", "description": "Free-text comment shown on the org-chart node."}, "ghost_contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the ghost contact."}, "lead_oppty_contact_group_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent org-chart group."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity."}, "position_in_group": {"type": "object", "description": "Org-chart layout position of the ghost contact within its group, as a JSON object {\"x\": <int>, \"y\": <int>}."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sales_roles": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to GhostLeadOpptyContactSalesRoleRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'GhostLeadOpptyContactSalesRoleRelation' object for properties."}, "description": "Sales roles assigned to the ghost contact on this lead/opportunity."}}, "required": ["is_delete_protected", "id", "ghost_contact", "ghost_contact_id", "lead_oppty_id"]}, "createGhostLeadOpptyContactRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "ghost_contact": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Placeholder ghost contact placed on the lead/opportunity org chart.\n\nRelation to GhostContact, see: 'createGhostContactInput' object for properties."}, "lead_oppty_contact_group_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Org-chart group the ghost contact belongs to, when grouped.\n\nRelation to LeadOpptyContactGroupRelation, see: 'createLeadOpptyContactGroupRelationInput' object for properties."}, "comment": {"type": "string", "example": "string", "description": "Free-text comment shown on the org-chart node."}, "ghost_contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the ghost contact."}, "lead_oppty_contact_group_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent org-chart group."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity."}, "position_in_group": {"type": "object", "description": "Org-chart layout position of the ghost contact within its group, as a JSON object {\"x\": <int>, \"y\": <int>}."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sales_roles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to GhostLeadOpptyContactSalesRoleRelation, see: 'createGhostLeadOpptyContactSalesRoleRelationInput' object for properties."}, "description": "Sales roles assigned to the ghost contact on this lead/opportunity."}}, "required": ["ghost_contact", "ghost_contact_id", "lead_oppty_id"]}, "updateGhostLeadOpptyContactRelationInput": {"properties": {"ghost_contact": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Placeholder ghost contact placed on the lead/opportunity org chart.\n\nRelation to GhostContact, see: 'updateGhostContactInput' object for properties."}, "lead_oppty_contact_group_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Org-chart group the ghost contact belongs to, when grouped.\n\nRelation to LeadOpptyContactGroupRelation, see: 'updateLeadOpptyContactGroupRelationInput' object for properties."}, "comment": {"type": "string", "example": "string", "description": "Free-text comment shown on the org-chart node."}, "ghost_contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the ghost contact."}, "lead_oppty_contact_group_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent org-chart group."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity."}, "position_in_group": {"type": "object", "description": "Org-chart layout position of the ghost contact within its group, as a JSON object {\"x\": <int>, \"y\": <int>}."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sales_roles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to GhostLeadOpptyContactSalesRoleRelation, see: 'updateGhostLeadOpptyContactSalesRoleRelationInput' object for properties."}, "description": "Sales roles assigned to the ghost contact on this lead/opportunity."}}}, "batchGhostLeadOpptyContactRelationInput": {"properties": {"ghost_contact": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Placeholder ghost contact placed on the lead/opportunity org chart.\n\nRelation to GhostContact, see: 'updateGhostContactInput' object for properties."}, "lead_oppty_contact_group_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Org-chart group the ghost contact belongs to, when grouped.\n\nRelation to LeadOpptyContactGroupRelation, see: 'updateLeadOpptyContactGroupRelationInput' object for properties."}, "comment": {"type": "string", "example": "string", "description": "Free-text comment shown on the org-chart node."}, "ghost_contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the ghost contact."}, "lead_oppty_contact_group_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent org-chart group."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity."}, "position_in_group": {"type": "object", "description": "Org-chart layout position of the ghost contact within its group, as a JSON object {\"x\": <int>, \"y\": <int>}."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sales_roles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to GhostLeadOpptyContactSalesRoleRelation, see: 'updateGhostLeadOpptyContactSalesRoleRelationInput' object for properties."}, "description": "Sales roles assigned to the ghost contact on this lead/opportunity."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "GhostLeadOpptyContactSalesRoleRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "ghost_lead_oppty_contact_relation": {"type": "string", "format": "uri", "description": "Ghost-contact-on-lead/opportunity placement this role assignment belongs to.\n\nRelation to GhostLeadOpptyContactRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'GhostLeadOpptyContactRelation' object for properties."}, "sales_role": {"type": "string", "format": "uri", "description": "Sales role assigned to the ghost contact.\n\nRelation to SalesRole. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesRole' object for properties."}, "ghost_lead_oppty_contact_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the ghost-contact-lead/opportunity placement."}, "sales_role_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales role."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "ghost_lead_oppty_contact_relation", "sales_role", "ghost_lead_oppty_contact_relation_id", "sales_role_id"]}, "createGhostLeadOpptyContactSalesRoleRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "ghost_lead_oppty_contact_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Ghost-contact-on-lead/opportunity placement this role assignment belongs to.\n\nRelation to GhostLeadOpptyContactRelation, see: 'createGhostLeadOpptyContactRelationInput' object for properties."}, "ghost_lead_oppty_contact_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the ghost-contact-lead/opportunity placement."}, "sales_role_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales role."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["ghost_lead_oppty_contact_relation", "ghost_lead_oppty_contact_relation_id", "sales_role_id"]}, "updateGhostLeadOpptyContactSalesRoleRelationInput": {"properties": {"ghost_lead_oppty_contact_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Ghost-contact-on-lead/opportunity placement this role assignment belongs to.\n\nRelation to GhostLeadOpptyContactRelation, see: 'updateGhostLeadOpptyContactRelationInput' object for properties."}, "ghost_lead_oppty_contact_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the ghost-contact-lead/opportunity placement."}, "sales_role_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales role."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchGhostLeadOpptyContactSalesRoleRelationInput": {"properties": {"ghost_lead_oppty_contact_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Ghost-contact-on-lead/opportunity placement this role assignment belongs to.\n\nRelation to GhostLeadOpptyContactRelation, see: 'updateGhostLeadOpptyContactRelationInput' object for properties."}, "ghost_lead_oppty_contact_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the ghost-contact-lead/opportunity placement."}, "sales_role_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales role."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ImportMappingMask": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "owner": {"type": "string", "format": "uri", "description": "User who owns the import mapping mask.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "entity_api_name": {"type": "string", "example": "string", "description": "API name of the entity this mask is configured for (e.g. \"Account\", \"Contact\", a custom entity's API name)."}, "entity_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Lead, 2 - Opportunity, 3 - Account, 4 - Contact, 5 - Client, 6 - Product, 7 - ProductPriceListPrice, 8 - CustomEntity", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8]}, "mapping": {"type": "object", "description": "Import mapping mask/relation_types in json format"}, "name": {"type": "string", "example": "string", "description": "Display name of the mask."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "relation_types": {"type": "object", "description": "Import mapping mask/relation_types in json format"}, "share_mode": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Private, 2 - Public, 0 - SelectedUnitsAndUsers", "example": 0, "enum": [0, 1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sharing_clients": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "description": "Users granted shared access to this import mapping mask (custom share mode)."}, "sharing_units": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "description": "Sales units granted shared access to this import mapping mask (custom share mode)."}}, "required": ["is_delete_protected", "id", "owner", "entity_type", "mapping", "name", "owner_id"]}, "createImportMappingMaskInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "entity_api_name": {"type": "string", "example": "string", "description": "API name of the entity this mask is configured for (e.g. \"Account\", \"Contact\", a custom entity's API name)."}, "entity_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Lead, 2 - Opportunity, 3 - Account, 4 - Contact, 5 - Client, 6 - Product, 7 - ProductPriceListPrice, 8 - CustomEntity", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8]}, "mapping": {"type": "object", "description": "Import mapping mask/relation_types in json format"}, "name": {"type": "string", "example": "string", "description": "Display name of the mask."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "relation_types": {"type": "object", "description": "Import mapping mask/relation_types in json format"}, "share_mode": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Private, 2 - Public, 0 - SelectedUnitsAndUsers", "example": 0, "enum": [0, 1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to Client, see: 'createClientInput' object for properties."}, "description": "Users granted shared access to this import mapping mask (custom share mode)."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to SalesUnit, see: 'createSalesUnitInput' object for properties."}, "description": "Sales units granted shared access to this import mapping mask (custom share mode)."}}, "required": ["entity_type", "mapping", "name", "owner_id"]}, "updateImportMappingMaskInput": {"properties": {"entity_api_name": {"type": "string", "example": "string", "description": "API name of the entity this mask is configured for (e.g. \"Account\", \"Contact\", a custom entity's API name)."}, "entity_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Lead, 2 - Opportunity, 3 - Account, 4 - Contact, 5 - Client, 6 - Product, 7 - ProductPriceListPrice, 8 - CustomEntity", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8]}, "mapping": {"type": "object", "description": "Import mapping mask/relation_types in json format"}, "name": {"type": "string", "example": "string", "description": "Display name of the mask."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "relation_types": {"type": "object", "description": "Import mapping mask/relation_types in json format"}, "share_mode": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Private, 2 - Public, 0 - SelectedUnitsAndUsers", "example": 0, "enum": [0, 1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to Client, see: 'updateClientInput' object for properties."}, "description": "Users granted shared access to this import mapping mask (custom share mode)."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to SalesUnit, see: 'updateSalesUnitInput' object for properties."}, "description": "Sales units granted shared access to this import mapping mask (custom share mode)."}}}, "batchImportMappingMaskInput": {"properties": {"entity_api_name": {"type": "string", "example": "string", "description": "API name of the entity this mask is configured for (e.g. \"Account\", \"Contact\", a custom entity's API name)."}, "entity_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Lead, 2 - Opportunity, 3 - Account, 4 - Contact, 5 - Client, 6 - Product, 7 - ProductPriceListPrice, 8 - CustomEntity", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8]}, "mapping": {"type": "object", "description": "Import mapping mask/relation_types in json format"}, "name": {"type": "string", "example": "string", "description": "Display name of the mask."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "relation_types": {"type": "object", "description": "Import mapping mask/relation_types in json format"}, "share_mode": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Private, 2 - Public, 0 - SelectedUnitsAndUsers", "example": 0, "enum": [0, 1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to Client, see: 'updateClientInput' object for properties."}, "description": "Users granted shared access to this import mapping mask (custom share mode)."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to SalesUnit, see: 'updateSalesUnitInput' object for properties."}, "description": "Sales units granted shared access to this import mapping mask (custom share mode)."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "InterfacePreview": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "has_draft": {"type": "boolean", "example": false, "description": "Set to True if draft for entity exists and can be published"}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_type": {"type": "string", "format": "uri", "description": "Account type the interface preview applies to.\n\nRelation to AccountType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountType' object for properties."}, "appointment_type": {"type": "string", "format": "uri", "description": "Appointment type the interface preview applies to.\n\nRelation to AppointmentType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentType' object for properties."}, "contact_type": {"type": "string", "format": "uri", "description": "Contact type the interface preview applies to.\n\nRelation to ContactType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactType' object for properties."}, "custom_entity_type": {"type": "string", "format": "uri", "description": "Custom entity type the interface preview applies to.\n\nRelation to CustomEntityType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntityType' object for properties."}, "lead_type": {"type": "string", "format": "uri", "description": "Lead type the interface preview applies to.\n\nRelation to LeadType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadType' object for properties."}, "oppty_type": {"type": "string", "format": "uri", "description": "Opportunity type the interface preview applies to.\n\nRelation to OpportunityType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpportunityType' object for properties."}, "product_type": {"type": "string", "format": "uri", "description": "Product type the interface preview applies to.\n\nRelation to ProductType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProductType' object for properties."}, "project_type": {"type": "string", "format": "uri", "description": "Project type the interface preview applies to.\n\nRelation to ProjectType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProjectType' object for properties."}, "quote_type": {"type": "string", "format": "uri", "description": "Quote type the interface preview applies to.\n\nRelation to QuoteType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'QuoteType' object for properties."}, "task_type": {"type": "string", "format": "uri", "description": "Task type the interface preview applies to.\n\nRelation to TaskType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TaskType' object for properties."}, "account_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account type.", "readOnly": true}, "appointment_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment type.", "readOnly": true}, "card_field_ids": {"type": "object", "description": "Ordered ids of fields shown on the record's compact card view."}, "charts": {"type": "object", "description": "Chart configurations shown in the preview, each linked to a related entity (e.g. recent activities, related contacts, comments)."}, "contact_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact type.", "readOnly": true}, "custom_entity_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the custom entity type.", "readOnly": true}, "detail_tabs": {"type": "object", "description": "Tab configurations shown on the record's detail screen (Detail tab plus related-entity and lookup tabs)."}, "detail_widgets": {"type": "object", "description": "Widget configurations shown on the record's detail screen sidebar (e.g. Status, KPIs)."}, "field_ids": {"type": "object", "description": "Ordered ids of fields shown in the record's preview pane."}, "lead_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead type.", "readOnly": true}, "oppty_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity type.", "readOnly": true}, "product_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product type.", "readOnly": true}, "project_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project type.", "readOnly": true}, "quote_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote type.", "readOnly": true}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Layout-customization settings for the preview (e.g. is_layout_customization_enabled)."}, "task_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the task type.", "readOnly": true}, "is_published": {"type": "boolean", "example": false, "description": "True when the interface preview is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "entity_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the type the interface preview is configured for, derived from whichever of the per-entity-type relations is set.", "readOnly": true}, "entity_type": {"type": "integer", "description": "Entity kind the interface preview applies to (Account, Lead, Opportunity, Contact, Task, Appointment, Project, Quote, CustomEntity, or Product). Derived from whichever of the per-entity-type relations is set.\n\nInteger enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]}}, "required": ["is_delete_protected", "has_draft", "id", "card_field_ids", "charts", "detail_tabs", "detail_widgets", "field_ids", "settings", "entity_type_id", "entity_type"]}, "createInterfacePreviewInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account type.", "readOnly": true}, "appointment_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment type.", "readOnly": true}, "card_field_ids": {"type": "object", "description": "Ordered ids of fields shown on the record's compact card view."}, "charts": {"type": "object", "description": "Chart configurations shown in the preview, each linked to a related entity (e.g. recent activities, related contacts, comments)."}, "contact_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact type.", "readOnly": true}, "custom_entity_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the custom entity type.", "readOnly": true}, "detail_tabs": {"type": "object", "description": "Tab configurations shown on the record's detail screen (Detail tab plus related-entity and lookup tabs)."}, "detail_widgets": {"type": "object", "description": "Widget configurations shown on the record's detail screen sidebar (e.g. Status, KPIs)."}, "field_ids": {"type": "object", "description": "Ordered ids of fields shown in the record's preview pane."}, "lead_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead type.", "readOnly": true}, "oppty_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity type.", "readOnly": true}, "product_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product type.", "readOnly": true}, "project_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project type.", "readOnly": true}, "quote_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote type.", "readOnly": true}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Layout-customization settings for the preview (e.g. is_layout_customization_enabled)."}, "task_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the task type.", "readOnly": true}, "is_published": {"type": "boolean", "example": false, "description": "True when the interface preview is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "entity_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the type the interface preview is configured for, derived from whichever of the per-entity-type relations is set.", "readOnly": true}}, "required": ["card_field_ids", "charts", "detail_tabs", "detail_widgets", "field_ids", "settings", "entity_type_id"]}, "updateInterfacePreviewInput": {"properties": {"card_field_ids": {"type": "object", "description": "Ordered ids of fields shown on the record's compact card view."}, "charts": {"type": "object", "description": "Chart configurations shown in the preview, each linked to a related entity (e.g. recent activities, related contacts, comments)."}, "detail_tabs": {"type": "object", "description": "Tab configurations shown on the record's detail screen (Detail tab plus related-entity and lookup tabs)."}, "detail_widgets": {"type": "object", "description": "Widget configurations shown on the record's detail screen sidebar (e.g. Status, KPIs)."}, "field_ids": {"type": "object", "description": "Ordered ids of fields shown in the record's preview pane."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Layout-customization settings for the preview (e.g. is_layout_customization_enabled)."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchInterfacePreviewInput": {"properties": {"card_field_ids": {"type": "object", "description": "Ordered ids of fields shown on the record's compact card view."}, "charts": {"type": "object", "description": "Chart configurations shown in the preview, each linked to a related entity (e.g. recent activities, related contacts, comments)."}, "detail_tabs": {"type": "object", "description": "Tab configurations shown on the record's detail screen (Detail tab plus related-entity and lookup tabs)."}, "detail_widgets": {"type": "object", "description": "Widget configurations shown on the record's detail screen sidebar (e.g. Status, KPIs)."}, "field_ids": {"type": "object", "description": "Ordered ids of fields shown in the record's preview pane."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Layout-customization settings for the preview (e.g. is_layout_customization_enabled)."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Lead": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time."}, "currency_exchange_rates_list": {"type": "string", "format": "uri", "description": "Currency exchange rate list used to convert monetary fields linked to this lead. Empty to inherit the team space default.\n\nRelation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRatesList' object for properties."}, "lead_source": {"type": "string", "format": "uri", "description": "How the lead originated (e.g. Website, Referral, Trade Show). Configurable per team space.\n\nRelation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties."}, "lead_type": {"type": "string", "format": "uri", "description": "Lead type that classifies this lead. Lead types are configurable per team space and drive which form, fields and lead process apply.\n\nRelation to LeadType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadType' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "Sales user who owns this lead. May be empty when the lead is unassigned and available for take-over.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "reason_of_close": {"type": "string", "format": "uri", "description": "Configurable reason recorded when the lead is archived (lost). Required when the lost form mandates it.\n\nRelation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties."}, "step": {"type": "string", "format": "uri", "description": "Step in the lead process the lead is currently in.\n\nRelation to Step. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Step' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit this lead is assigned to. Determines which team members can see the record under unit-based sharing.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this lead."}, "description": {"type": "string", "example": "string", "description": "Free-form description of the lead."}, "is_archived": {"type": "boolean", "example": false, "description": "True when the lead has been archived (lost). Archived leads remain readable but are hidden from active lists and cannot be edited until reactivated."}, "label_flag": {"type": "string", "example": 1, "enum": [1, 2, 4], "description": "User-set colored flag used to highlight the lead in lists and reports."}, "last_ai_buying_center_applied": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Time when an AI-suggested buying center was last applied to this lead."}, "lead_source_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead source."}, "lead_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead type."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead owner."}, "quick_account_email": {"type": "string", "example": "string", "description": "Free-text company email captured at lead creation when no Account record has been linked yet."}, "quick_account_name": {"type": "string", "example": "string", "description": "Free-text company name captured at lead creation when no Account record has been linked yet."}, "quick_account_phone": {"type": "string", "example": "string", "description": "Free-text company phone captured at lead creation when no Account record has been linked yet."}, "quick_contact_name": {"type": "string", "example": "string", "description": "Free-text contact name captured at lead creation when no Contact record has been linked yet."}, "quick_email": {"type": "string", "example": "string", "description": "Free-text contact email captured at lead creation when no Contact record has been linked yet."}, "quick_phone": {"type": "string", "example": "string", "description": "Free-text contact phone captured at lead creation when no Contact record has been linked yet."}, "ranking": {"type": "integer", "format": "int32", "example": 1, "description": "Qualitative ranking score (1-10) the user assigns to indicate the strength of the lead."}, "reason_of_close_description": {"type": "string", "example": "string", "description": "Free-form note explaining why the lead was archived (lost). Captured alongside reason_of_close."}, "reason_of_close_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the reason-of-close value."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "step_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead process step."}, "table_name": {"type": "string", "example": "string", "description": "Discriminator identifying the concrete record type \u2014 always \"lead\" for Lead records. Read-only; useful when consuming polymorphic LeadOppty results.", "readOnly": true}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "primary_contact": {"type": "string", "format": "uri", "description": "Primary contact of this lead. Set automatically from the contact relation marked as primary.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "primary_account": {"type": "string", "format": "uri", "description": "Primary account of this lead. Set automatically from the account relation marked as primary.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "contact_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to LeadOpptyContactRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadOpptyContactRelation' object for properties."}, "description": "Contacts linked to this lead, including their roles and org-chart positions."}, "account_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to LeadOpptyAccountRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadOpptyAccountRelation' object for properties."}, "description": "Accounts linked to this lead, including the primary-account flag."}, "status": {"type": "integer", "description": "Current status of the lead (Open, Lost, Qualified). Read-only; derived from the archived flag and lifecycle events.\n\nInteger enum value: 1 - Open, 2 - Lost", "example": 1, "enum": [1, 2], "readOnly": true}, "sharing_units": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to LeadOpptySharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadOpptySharingSalesUnitRelation' object for properties."}, "description": "Sales units that have been granted shared access to this lead. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to LeadOpptySharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadOpptySharingClientRelation' object for properties."}, "description": "Users that have been granted shared access to this lead. Editable only when share_mode allows user sharing."}, "documents": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties."}, "description": "Documents linked to this lead."}, "tags": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to TagRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TagRelation' object for properties."}, "description": "Tag labels applied to this lead."}, "static_profiles": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ProfileRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProfileRelation' object for properties."}, "description": "Saved view profiles this lead currently matches."}, "qualify_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of when the lead was qualified, taken from the matching KPI event. Empty for leads that have not been qualified. Read-only."}, "days_in_step": {"type": "integer", "format": "int32", "example": 1, "description": "Number of days the lead has been sitting in its current pipeline step. Read-only; computed by Coevera from the most recent move event."}, "is_favorite": {"type": "boolean", "example": false, "description": "True when the current authenticated user has marked this lead as favorite. Per-user."}, "lost_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of when the lead was archived (lost). Setting it adjusts the underlying loss event; empty for leads that have not been archived."}, "formatted_name": {"type": "string", "example": "string", "description": "Display version of the lead name, used in lists and references."}, "scoring": {"type": "object", "description": "Lead scoring summary, combining the percentile and current scoring state. Read-only; computed by Coevera."}, "modified_by_user": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera."}}, "required": ["is_delete_protected", "id", "lead_type", "step", "unit", "name", "table_name", "status", "days_in_step", "is_favorite", "formatted_name"]}, "createLeadInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this lead."}, "description": {"type": "string", "example": "string", "description": "Free-form description of the lead."}, "is_archived": {"type": "boolean", "example": false, "description": "True when the lead has been archived (lost). Archived leads remain readable but are hidden from active lists and cannot be edited until reactivated."}, "label_flag": {"type": "string", "example": 1, "enum": [1, 2, 4], "description": "User-set colored flag used to highlight the lead in lists and reports."}, "last_ai_buying_center_applied": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Time when an AI-suggested buying center was last applied to this lead."}, "lead_source_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead source."}, "lead_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead type."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead owner."}, "quick_account_email": {"type": "string", "example": "string", "description": "Free-text company email captured at lead creation when no Account record has been linked yet."}, "quick_account_name": {"type": "string", "example": "string", "description": "Free-text company name captured at lead creation when no Account record has been linked yet."}, "quick_account_phone": {"type": "string", "example": "string", "description": "Free-text company phone captured at lead creation when no Account record has been linked yet."}, "quick_contact_name": {"type": "string", "example": "string", "description": "Free-text contact name captured at lead creation when no Contact record has been linked yet."}, "quick_email": {"type": "string", "example": "string", "description": "Free-text contact email captured at lead creation when no Contact record has been linked yet."}, "quick_phone": {"type": "string", "example": "string", "description": "Free-text contact phone captured at lead creation when no Contact record has been linked yet."}, "ranking": {"type": "integer", "format": "int32", "example": 1, "description": "Qualitative ranking score (1-10) the user assigns to indicate the strength of the lead."}, "reason_of_close_description": {"type": "string", "example": "string", "description": "Free-form note explaining why the lead was archived (lost). Captured alongside reason_of_close."}, "reason_of_close_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the reason-of-close value."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "step_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead process step."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptyContactRelation, see: 'createLeadOpptyContactRelationInput' object for properties."}, "description": "Contacts linked to this lead, including their roles and org-chart positions."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptyAccountRelation, see: 'createLeadOpptyAccountRelationInput' object for properties."}, "description": "Accounts linked to this lead, including the primary-account flag."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptySharingSalesUnitRelation, see: 'createLeadOpptySharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this lead. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptySharingClientRelation, see: 'createLeadOpptySharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this lead. Editable only when share_mode allows user sharing."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this lead."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'createTagRelationInput' object for properties."}, "description": "Tag labels applied to this lead."}, "static_profiles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProfileRelation, see: 'createProfileRelationInput' object for properties."}, "description": "Saved view profiles this lead currently matches."}, "lost_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of when the lead was archived (lost). Setting it adjusts the underlying loss event; empty for leads that have not been archived."}}, "required": ["name"]}, "updateLeadInput": {"properties": {"created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this lead."}, "description": {"type": "string", "example": "string", "description": "Free-form description of the lead."}, "is_archived": {"type": "boolean", "example": false, "description": "True when the lead has been archived (lost). Archived leads remain readable but are hidden from active lists and cannot be edited until reactivated."}, "label_flag": {"type": "string", "example": 1, "enum": [1, 2, 4], "description": "User-set colored flag used to highlight the lead in lists and reports."}, "last_ai_buying_center_applied": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Time when an AI-suggested buying center was last applied to this lead."}, "lead_source_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead source."}, "lead_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead type."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead owner."}, "quick_account_email": {"type": "string", "example": "string", "description": "Free-text company email captured at lead creation when no Account record has been linked yet."}, "quick_account_name": {"type": "string", "example": "string", "description": "Free-text company name captured at lead creation when no Account record has been linked yet."}, "quick_account_phone": {"type": "string", "example": "string", "description": "Free-text company phone captured at lead creation when no Account record has been linked yet."}, "quick_contact_name": {"type": "string", "example": "string", "description": "Free-text contact name captured at lead creation when no Contact record has been linked yet."}, "quick_email": {"type": "string", "example": "string", "description": "Free-text contact email captured at lead creation when no Contact record has been linked yet."}, "quick_phone": {"type": "string", "example": "string", "description": "Free-text contact phone captured at lead creation when no Contact record has been linked yet."}, "ranking": {"type": "integer", "format": "int32", "example": 1, "description": "Qualitative ranking score (1-10) the user assigns to indicate the strength of the lead."}, "reason_of_close_description": {"type": "string", "example": "string", "description": "Free-form note explaining why the lead was archived (lost). Captured alongside reason_of_close."}, "reason_of_close_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the reason-of-close value."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "step_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead process step."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptyContactRelation, see: 'updateLeadOpptyContactRelationInput' object for properties."}, "description": "Contacts linked to this lead, including their roles and org-chart positions."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptyAccountRelation, see: 'updateLeadOpptyAccountRelationInput' object for properties."}, "description": "Accounts linked to this lead, including the primary-account flag."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptySharingSalesUnitRelation, see: 'updateLeadOpptySharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this lead. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptySharingClientRelation, see: 'updateLeadOpptySharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this lead. Editable only when share_mode allows user sharing."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this lead."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'updateTagRelationInput' object for properties."}, "description": "Tag labels applied to this lead."}, "static_profiles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProfileRelation, see: 'updateProfileRelationInput' object for properties."}, "description": "Saved view profiles this lead currently matches."}, "lost_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of when the lead was archived (lost). Setting it adjusts the underlying loss event; empty for leads that have not been archived."}}}, "batchLeadInput": {"properties": {"created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this lead."}, "description": {"type": "string", "example": "string", "description": "Free-form description of the lead."}, "is_archived": {"type": "boolean", "example": false, "description": "True when the lead has been archived (lost). Archived leads remain readable but are hidden from active lists and cannot be edited until reactivated."}, "label_flag": {"type": "string", "example": 1, "enum": [1, 2, 4], "description": "User-set colored flag used to highlight the lead in lists and reports."}, "last_ai_buying_center_applied": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Time when an AI-suggested buying center was last applied to this lead."}, "lead_source_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead source."}, "lead_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead type."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead owner."}, "quick_account_email": {"type": "string", "example": "string", "description": "Free-text company email captured at lead creation when no Account record has been linked yet."}, "quick_account_name": {"type": "string", "example": "string", "description": "Free-text company name captured at lead creation when no Account record has been linked yet."}, "quick_account_phone": {"type": "string", "example": "string", "description": "Free-text company phone captured at lead creation when no Account record has been linked yet."}, "quick_contact_name": {"type": "string", "example": "string", "description": "Free-text contact name captured at lead creation when no Contact record has been linked yet."}, "quick_email": {"type": "string", "example": "string", "description": "Free-text contact email captured at lead creation when no Contact record has been linked yet."}, "quick_phone": {"type": "string", "example": "string", "description": "Free-text contact phone captured at lead creation when no Contact record has been linked yet."}, "ranking": {"type": "integer", "format": "int32", "example": 1, "description": "Qualitative ranking score (1-10) the user assigns to indicate the strength of the lead."}, "reason_of_close_description": {"type": "string", "example": "string", "description": "Free-form note explaining why the lead was archived (lost). Captured alongside reason_of_close."}, "reason_of_close_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the reason-of-close value."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "step_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead process step."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptyContactRelation, see: 'updateLeadOpptyContactRelationInput' object for properties."}, "description": "Contacts linked to this lead, including their roles and org-chart positions."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptyAccountRelation, see: 'updateLeadOpptyAccountRelationInput' object for properties."}, "description": "Accounts linked to this lead, including the primary-account flag."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptySharingSalesUnitRelation, see: 'updateLeadOpptySharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this lead. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptySharingClientRelation, see: 'updateLeadOpptySharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this lead. Editable only when share_mode allows user sharing."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this lead."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'updateTagRelationInput' object for properties."}, "description": "Tag labels applied to this lead."}, "static_profiles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProfileRelation, see: 'updateProfileRelationInput' object for properties."}, "description": "Saved view profiles this lead currently matches."}, "lost_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of when the lead was archived (lost). Setting it adjusts the underlying loss event; empty for leads that have not been archived."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "LeadOppty": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}}, "required": ["is_delete_protected", "id"]}, "LeadOpptyAccountRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account": {"type": "string", "format": "uri", "description": "Account linked to the lead or opportunity.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "lead": {"type": "string", "format": "uri", "description": "Lead the account is linked to. Set when lead_oppty_id resolves to a Lead; otherwise empty.\n\nRelation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties."}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity the account is linked to. Set when lead_oppty_id resolves to an Opportunity; otherwise empty.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity this link belongs to."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "account", "account_id", "is_primary", "lead_oppty_id"]}, "createLeadOpptyAccountRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity this link belongs to."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["account_id", "is_primary", "lead_oppty_id"]}, "updateLeadOpptyAccountRelationInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity this link belongs to."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchLeadOpptyAccountRelationInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity this link belongs to."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "LeadOpptyContactGroupRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "lead": {"type": "string", "format": "uri", "description": "Lead this contact group belongs to. Set when lead_oppty_id resolves to a Lead; otherwise empty.\n\nRelation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties."}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity this contact group belongs to. Set when lead_oppty_id resolves to an Opportunity; otherwise empty.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the contact group on the org chart, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue."}, "group_position": {"type": "object", "description": "Org-chart layout of the contact group, as a JSON object {\"x\": <int>, \"y\": <int>, \"width\": <int>, \"height\": <int>}."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity the contact group belongs to."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "color", "group_position", "lead_oppty_id", "name"]}, "createLeadOpptyContactGroupRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the contact group on the org chart, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue."}, "group_position": {"type": "object", "description": "Org-chart layout of the contact group, as a JSON object {\"x\": <int>, \"y\": <int>, \"width\": <int>, \"height\": <int>}."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity the contact group belongs to."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["color", "group_position", "lead_oppty_id", "name"]}, "updateLeadOpptyContactGroupRelationInput": {"properties": {"color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the contact group on the org chart, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue."}, "group_position": {"type": "object", "description": "Org-chart layout of the contact group, as a JSON object {\"x\": <int>, \"y\": <int>, \"width\": <int>, \"height\": <int>}."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity the contact group belongs to."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchLeadOpptyContactGroupRelationInput": {"properties": {"color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the contact group on the org chart, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue."}, "group_position": {"type": "object", "description": "Org-chart layout of the contact group, as a JSON object {\"x\": <int>, \"y\": <int>, \"width\": <int>, \"height\": <int>}."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity the contact group belongs to."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "LeadOpptyContactRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "contact": {"type": "string", "format": "uri", "description": "Contact linked to the lead or opportunity.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "lead_oppty_contact_group_relation": {"type": "string", "format": "uri", "description": "Contact group on the org chart this contact belongs to, or empty for ungrouped contacts.\n\nRelation to LeadOpptyContactGroupRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadOpptyContactGroupRelation' object for properties."}, "lead": {"type": "string", "format": "uri", "description": "Lead the contact is linked to. Set when lead_oppty_id resolves to a Lead; otherwise empty.\n\nRelation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties."}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity the contact is linked to. Set when lead_oppty_id resolves to an Opportunity; otherwise empty.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "comment": {"type": "string", "example": "string", "description": "Free-form note describing this contact link."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row."}, "lead_oppty_contact_group_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact group."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity this link belongs to."}, "position_in_group": {"type": "object", "description": "Org-chart layout position of the contact within its group, as a JSON object {\"x\": <int>, \"y\": <int>}."}, "relationship": {"type": "integer", "description": "Org-chart relationship of the contact within the lead/opportunity hierarchy.\n\nInteger enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong", "example": 0, "enum": [0, 1, 2, 3]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sales_roles": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to LeadOpptyContactSalesRoleRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadOpptyContactSalesRoleRelation' object for properties."}, "description": "Sales roles assigned to the contact for this lead or opportunity."}}, "required": ["is_delete_protected", "id", "contact", "contact_id", "is_primary", "lead_oppty_id"]}, "createLeadOpptyContactRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "lead_oppty_contact_group_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Contact group on the org chart this contact belongs to, or empty for ungrouped contacts.\n\nRelation to LeadOpptyContactGroupRelation, see: 'createLeadOpptyContactGroupRelationInput' object for properties."}, "comment": {"type": "string", "example": "string", "description": "Free-form note describing this contact link."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row."}, "lead_oppty_contact_group_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact group."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity this link belongs to."}, "position_in_group": {"type": "object", "description": "Org-chart layout position of the contact within its group, as a JSON object {\"x\": <int>, \"y\": <int>}."}, "relationship": {"type": "integer", "description": "Org-chart relationship of the contact within the lead/opportunity hierarchy.\n\nInteger enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong", "example": 0, "enum": [0, 1, 2, 3]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sales_roles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptyContactSalesRoleRelation, see: 'createLeadOpptyContactSalesRoleRelationInput' object for properties."}, "description": "Sales roles assigned to the contact for this lead or opportunity."}}, "required": ["contact_id", "is_primary", "lead_oppty_id"]}, "updateLeadOpptyContactRelationInput": {"properties": {"lead_oppty_contact_group_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Contact group on the org chart this contact belongs to, or empty for ungrouped contacts.\n\nRelation to LeadOpptyContactGroupRelation, see: 'updateLeadOpptyContactGroupRelationInput' object for properties."}, "comment": {"type": "string", "example": "string", "description": "Free-form note describing this contact link."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row."}, "lead_oppty_contact_group_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact group."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity this link belongs to."}, "position_in_group": {"type": "object", "description": "Org-chart layout position of the contact within its group, as a JSON object {\"x\": <int>, \"y\": <int>}."}, "relationship": {"type": "integer", "description": "Org-chart relationship of the contact within the lead/opportunity hierarchy.\n\nInteger enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong", "example": 0, "enum": [0, 1, 2, 3]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sales_roles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptyContactSalesRoleRelation, see: 'updateLeadOpptyContactSalesRoleRelationInput' object for properties."}, "description": "Sales roles assigned to the contact for this lead or opportunity."}}}, "batchLeadOpptyContactRelationInput": {"properties": {"lead_oppty_contact_group_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Contact group on the org chart this contact belongs to, or empty for ungrouped contacts.\n\nRelation to LeadOpptyContactGroupRelation, see: 'updateLeadOpptyContactGroupRelationInput' object for properties."}, "comment": {"type": "string", "example": "string", "description": "Free-form note describing this contact link."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row."}, "lead_oppty_contact_group_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact group."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity this link belongs to."}, "position_in_group": {"type": "object", "description": "Org-chart layout position of the contact within its group, as a JSON object {\"x\": <int>, \"y\": <int>}."}, "relationship": {"type": "integer", "description": "Org-chart relationship of the contact within the lead/opportunity hierarchy.\n\nInteger enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong", "example": 0, "enum": [0, 1, 2, 3]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sales_roles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptyContactSalesRoleRelation, see: 'updateLeadOpptyContactSalesRoleRelationInput' object for properties."}, "description": "Sales roles assigned to the contact for this lead or opportunity."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "LeadOpptyContactSalesRoleRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "lead_oppty_contact_relation": {"type": "string", "format": "uri", "description": "Lead/opportunity-contact link this sales-role assignment belongs to.\n\nRelation to LeadOpptyContactRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadOpptyContactRelation' object for properties."}, "sales_role": {"type": "string", "format": "uri", "description": "Sales role assigned to the contact on this lead or opportunity.\n\nRelation to SalesRole. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesRole' object for properties."}, "lead_oppty_contact_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead/opportunity-contact link."}, "sales_role_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales role."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "sales_role", "sales_role_id"]}, "createLeadOpptyContactSalesRoleRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "lead_oppty_contact_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Lead/opportunity-contact link this sales-role assignment belongs to.\n\nRelation to LeadOpptyContactRelation, see: 'createLeadOpptyContactRelationInput' object for properties."}, "lead_oppty_contact_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead/opportunity-contact link."}, "sales_role_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales role."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["sales_role_id"]}, "updateLeadOpptyContactSalesRoleRelationInput": {"properties": {"lead_oppty_contact_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Lead/opportunity-contact link this sales-role assignment belongs to.\n\nRelation to LeadOpptyContactRelation, see: 'updateLeadOpptyContactRelationInput' object for properties."}, "lead_oppty_contact_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead/opportunity-contact link."}, "sales_role_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales role."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchLeadOpptyContactSalesRoleRelationInput": {"properties": {"lead_oppty_contact_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Lead/opportunity-contact link this sales-role assignment belongs to.\n\nRelation to LeadOpptyContactRelation, see: 'updateLeadOpptyContactRelationInput' object for properties."}, "lead_oppty_contact_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead/opportunity-contact link."}, "sales_role_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales role."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "LeadOpptyDataExRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "data": {"type": "string", "format": "uri", "description": "Data record holding the additional fields linked to this lead or opportunity.\n\nRelation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties."}, "lead": {"type": "string", "format": "uri", "description": "Lead this data relation row applies to, when the row is associated with a lead.\n\nRelation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties."}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity this data relation row applies to, when the row is associated with an opportunity.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "data_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked data record."}, "data_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier of the data set the linked fields belong to."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity the data relation row applies to."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "data", "data_id", "data_set_id", "lead_oppty_id"]}, "LeadOpptyKPI": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client": {"type": "string", "format": "uri", "description": "User who triggered the KPI event (e.g. created the lead, qualified it, won or lost the opportunity, moved the record).\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "lead": {"type": "string", "format": "uri", "description": "Lead this KPI event relates to. Set when lead_oppty_id resolves to a Lead; otherwise empty.\n\nRelation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties."}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity this KPI event relates to. Set when lead_oppty_id resolves to an Opportunity; otherwise empty.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "Lead/opportunity owner at the time the KPI event occurred.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit the triggering user belonged to at the time of the event.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration)."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who triggered the event."}, "kpi": {"type": "integer", "description": "KPI metric this event represents: CreateLeads, CreateOppty, QualifyLead, WinOppty, LoseLead, LoseOppty, LastMove.\n\nInteger enum value: 1 - CreateLeads, 2 - CreateOppty, 4 - QualifyLead, 5 - WinOppty, 6 - LoseLead, 7 - LoseOppty, 8 - LastMove", "example": 1, "enum": [1, 2, 4, 5, 6, 7, 8]}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity the KPI event relates to."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead/opportunity owner at the time of the event."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "unit", "kpi", "lead_oppty_id", "unit_id"]}, "createLeadOpptyKPIInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration)."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who triggered the event."}, "kpi": {"type": "integer", "description": "KPI metric this event represents: CreateLeads, CreateOppty, QualifyLead, WinOppty, LoseLead, LoseOppty, LastMove.\n\nInteger enum value: 1 - CreateLeads, 2 - CreateOppty, 4 - QualifyLead, 5 - WinOppty, 6 - LoseLead, 7 - LoseOppty, 8 - LastMove", "example": 1, "enum": [1, 2, 4, 5, 6, 7, 8]}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity the KPI event relates to."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead/opportunity owner at the time of the event."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["kpi", "lead_oppty_id", "unit_id"]}, "updateLeadOpptyKPIInput": {"properties": {"application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration)."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who triggered the event."}, "kpi": {"type": "integer", "description": "KPI metric this event represents: CreateLeads, CreateOppty, QualifyLead, WinOppty, LoseLead, LoseOppty, LastMove.\n\nInteger enum value: 1 - CreateLeads, 2 - CreateOppty, 4 - QualifyLead, 5 - WinOppty, 6 - LoseLead, 7 - LoseOppty, 8 - LastMove", "example": 1, "enum": [1, 2, 4, 5, 6, 7, 8]}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity the KPI event relates to."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead/opportunity owner at the time of the event."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchLeadOpptyKPIInput": {"properties": {"application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration)."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who triggered the event."}, "kpi": {"type": "integer", "description": "KPI metric this event represents: CreateLeads, CreateOppty, QualifyLead, WinOppty, LoseLead, LoseOppty, LastMove.\n\nInteger enum value: 1 - CreateLeads, 2 - CreateOppty, 4 - QualifyLead, 5 - WinOppty, 6 - LoseLead, 7 - LoseOppty, 8 - LastMove", "example": 1, "enum": [1, 2, 4, 5, 6, 7, 8]}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity the KPI event relates to."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead/opportunity owner at the time of the event."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "LeadOpptySharingClientRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client": {"type": "string", "format": "uri", "description": "User the lead or opportunity is shared with.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "lead": {"type": "string", "format": "uri", "description": "Lead being shared. Set when lead_oppty_id resolves to a Lead; otherwise empty.\n\nRelation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties."}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity being shared. Set when lead_oppty_id resolves to an Opportunity; otherwise empty.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity being shared."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the lead or opportunity.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "client", "client_id", "lead_oppty_id"]}, "createLeadOpptySharingClientRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity being shared."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the lead or opportunity.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["client_id", "lead_oppty_id"]}, "updateLeadOpptySharingClientRelationInput": {"properties": {"client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity being shared."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the lead or opportunity.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchLeadOpptySharingClientRelationInput": {"properties": {"client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity being shared."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the lead or opportunity.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "LeadOpptySharingSalesUnitRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "lead": {"type": "string", "format": "uri", "description": "Lead being shared. Set when lead_oppty_id resolves to a Lead; otherwise empty.\n\nRelation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties."}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity being shared. Set when lead_oppty_id resolves to an Opportunity; otherwise empty.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit the lead or opportunity is shared with.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity being shared."}, "role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the lead or opportunity.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "unit", "lead_oppty_id", "unit_id"]}, "createLeadOpptySharingSalesUnitRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity being shared."}, "role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the lead or opportunity.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["lead_oppty_id", "unit_id"]}, "updateLeadOpptySharingSalesUnitRelationInput": {"properties": {"lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity being shared."}, "role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the lead or opportunity.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchLeadOpptySharingSalesUnitRelationInput": {"properties": {"lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity being shared."}, "role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the lead or opportunity.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "LeadOpptyStepCheckListRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "appointment": {"type": "string", "format": "uri", "description": "Appointment used as evidence for this checklist item. Set when activity_id resolves to an Appointment; otherwise empty.\n\nRelation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties."}, "task": {"type": "string", "format": "uri", "description": "Task used as evidence for this checklist item. Set when activity_id resolves to a Task; otherwise empty.\n\nRelation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties."}, "cloud_object": {"type": "string", "format": "uri", "description": "Document linked as evidence for this checklist item.\n\nRelation to CloudObject. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObject' object for properties."}, "email": {"type": "string", "format": "uri", "description": "Email linked as evidence for this checklist item.\n\nRelation to Email. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Email' object for properties."}, "lead": {"type": "string", "format": "uri", "description": "Lead this checklist completion belongs to. Set when lead_oppty_id resolves to a Lead; otherwise empty.\n\nRelation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties."}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity this checklist completion belongs to. Set when lead_oppty_id resolves to an Opportunity; otherwise empty.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "note": {"type": "string", "format": "uri", "description": "Note linked as evidence for this checklist item.\n\nRelation to Note. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Note' object for properties."}, "quote": {"type": "string", "format": "uri", "description": "Quote this checklist completion belongs to, or empty when it belongs to a lead or opportunity.\n\nRelation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties."}, "step_checklist": {"type": "string", "format": "uri", "description": "Step checklist item this completion record refers to.\n\nRelation to StepChecklist. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'StepChecklist' object for properties."}, "activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment or task linked as evidence for this checklist item."}, "cloud_object_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the document."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email."}, "item_checked": {"type": "boolean", "example": false, "description": "True when the checklist item has been completed for this lead, opportunity or quote."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity, or empty when this completion belongs to a quote."}, "note_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the note."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "step_checklist_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the step checklist item."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "step_checklist", "step_checklist_id"]}, "createLeadOpptyStepCheckListRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "cloud_object": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Document linked as evidence for this checklist item.\n\nRelation to CloudObject, see: 'createCloudObjectInput' object for properties."}, "note": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Note linked as evidence for this checklist item.\n\nRelation to Note, see: 'createNoteInput' object for properties."}, "activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment or task linked as evidence for this checklist item."}, "cloud_object_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the document."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email."}, "item_checked": {"type": "boolean", "example": false, "description": "True when the checklist item has been completed for this lead, opportunity or quote."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity, or empty when this completion belongs to a quote."}, "note_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the note."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "step_checklist_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the step checklist item."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["step_checklist_id"]}, "updateLeadOpptyStepCheckListRelationInput": {"properties": {"cloud_object": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Document linked as evidence for this checklist item.\n\nRelation to CloudObject, see: 'updateCloudObjectInput' object for properties."}, "note": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Note linked as evidence for this checklist item.\n\nRelation to Note, see: 'updateNoteInput' object for properties."}, "activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment or task linked as evidence for this checklist item."}, "cloud_object_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the document."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email."}, "item_checked": {"type": "boolean", "example": false, "description": "True when the checklist item has been completed for this lead, opportunity or quote."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity, or empty when this completion belongs to a quote."}, "note_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the note."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "step_checklist_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the step checklist item."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchLeadOpptyStepCheckListRelationInput": {"properties": {"cloud_object": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Document linked as evidence for this checklist item.\n\nRelation to CloudObject, see: 'updateCloudObjectInput' object for properties."}, "note": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Note linked as evidence for this checklist item.\n\nRelation to Note, see: 'updateNoteInput' object for properties."}, "activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment or task linked as evidence for this checklist item."}, "cloud_object_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the document."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email."}, "item_checked": {"type": "boolean", "example": false, "description": "True when the checklist item has been completed for this lead, opportunity or quote."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity, or empty when this completion belongs to a quote."}, "note_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the note."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "step_checklist_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the step checklist item."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "LeadProcess": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the lead process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "steps": {"type": "array", "items": {"$ref": "#/components/schemas/batchStepInput"}, "description": "Steps that make up this lead process, in evaluation order."}, "lead_types": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to LeadType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadType' object for properties."}, "description": "Lead types that follow this lead process."}}, "required": ["is_delete_protected", "id", "name", "steps", "lead_types"]}, "createLeadProcessInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the lead process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "steps": {"type": "array", "items": {"$ref": "#/components/schemas/batchStepInput"}, "description": "Steps that make up this lead process, in evaluation order."}}, "required": ["name", "steps"]}, "updateLeadProcessInput": {"properties": {"color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the lead process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "steps": {"type": "array", "items": {"$ref": "#/components/schemas/batchStepInput"}, "description": "Steps that make up this lead process, in evaluation order."}}}, "batchLeadProcessInput": {"properties": {"color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the lead process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "steps": {"type": "array", "items": {"$ref": "#/components/schemas/batchStepInput"}, "description": "Steps that make up this lead process, in evaluation order."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "LeadType": {"properties": {"id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "lead_process": {"type": "string", "format": "uri", "description": "Lead process (pipeline) this lead type follows.\n\nRelation to LeadProcess. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadProcess' object for properties."}, "form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing leads of this type."}, "form_lost": {"type": "object", "description": "JSON definition of the form shown when archiving (losing) a lead of this type. Used to capture reason of close and any required closing fields."}, "form_lost_enabled": {"type": "boolean", "example": false, "description": "True when the lost form is required on archiving leads of this type."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the lead type is system-managed and cannot be edited or deleted by users."}, "lead_process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead process."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "is_published": {"type": "boolean", "example": false, "description": "True when the entity configuration is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "has_draft": {"type": "boolean", "example": false, "description": "Set to True if draft for entity exists and can be published"}, "is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "form_edit_api": {"type": "object", "description": "API-friendly form definition. Returns the published form merged with any pending draft changes; read via this field, modify via the underlying form_edit / form_lost field through drafts."}, "can_change_readonly": {"type": "boolean", "example": false, "description": "Returns if user can change readonly flag on this entity_type."}, "form_lost_api": {"type": "object", "description": "API-friendly form definition. Returns the published form merged with any pending draft changes; read via this field, modify via the underlying form_edit / form_lost field through drafts."}}, "required": ["id", "lead_process", "form_lost_enabled", "is_readonly", "lead_process_id", "name", "settings", "has_draft", "is_delete_protected", "form_edit_api", "form_lost_api"]}, "createLeadTypeInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing leads of this type."}, "form_lost": {"type": "object", "description": "JSON definition of the form shown when archiving (losing) a lead of this type. Used to capture reason of close and any required closing fields."}, "form_lost_enabled": {"type": "boolean", "example": false, "description": "True when the lost form is required on archiving leads of this type."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the lead type is system-managed and cannot be edited or deleted by users."}, "lead_process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead process."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "is_published": {"type": "boolean", "example": false, "description": "True when the entity configuration is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["form_lost_enabled", "is_readonly", "lead_process_id", "name", "settings"]}, "updateLeadTypeInput": {"properties": {"form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing leads of this type."}, "form_lost": {"type": "object", "description": "JSON definition of the form shown when archiving (losing) a lead of this type. Used to capture reason of close and any required closing fields."}, "form_lost_enabled": {"type": "boolean", "example": false, "description": "True when the lost form is required on archiving leads of this type."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the lead type is system-managed and cannot be edited or deleted by users."}, "lead_process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead process."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchLeadTypeInput": {"properties": {"form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing leads of this type."}, "form_lost": {"type": "object", "description": "JSON definition of the form shown when archiving (losing) a lead of this type. Used to capture reason of close and any required closing fields."}, "form_lost_enabled": {"type": "boolean", "example": false, "description": "True when the lost form is required on archiving leads of this type."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the lead type is system-managed and cannot be edited or deleted by users."}, "lead_process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead process."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "MasterRight": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "access_account_relation_types": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_accounts": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_automatizer": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_online_forms": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_record_detail": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_record_enrichment": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_relationship_charts": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_reports": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_smart_field": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_appointment_scheduler": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_appointment_scheduler_management": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_approval_processes": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_approval_processes_management": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_approvals": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_archive": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_audit": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_audit_log": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_bulk_update": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_calling": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_calling_company_phone": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Selected, 2 - All", "example": 0, "enum": [0, 1, 2]}, "access_calling_purchase_phone": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_company_emails": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Selected, 2 - All", "example": 0, "enum": [0, 1, 2]}, "access_contacts": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_document_management": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_document_management_company": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_document_management_record": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_duplicate_checker": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_email_notification_enforcement": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_email_notification_settings": {"type": "object", "description": "Default email notification preferences applied to users with this role (which events trigger an email and through which channel)."}, "access_entity_account": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_account_copy": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_account_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_account_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_account_private": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_account_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_account_types": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - All, 2 - Selected", "example": 1, "enum": [1, 2]}, "access_entity_appointment": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_appointment_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_appointment_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_appointment_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_better_navigator": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_better_navigator_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_better_navigator_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_better_navigator_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_better_navigator_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_contact": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_contact_copy": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_contact_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_contact_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_contact_private": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_contact_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_contact_types": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - All, 2 - Selected", "example": 1, "enum": [1, 2]}, "access_entity_dashboard": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_dashboard_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_dashboard_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_dashboard_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_dashboard_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_email_content_share_mode": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - PrivateOnly, 1 - Custom, 2 - PublicOnly", "example": 0, "enum": [0, 1, 2]}, "access_entity_email_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_email_sequence": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess", "example": 1, "enum": [1, 2, 3]}, "access_entity_email_template": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_email_template_create_delete_folder": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_email_template_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_email_template_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_email_template_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_email_template_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_forecast": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_forecast_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_forecast_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_forecast_edit_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_forecast_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_forecast_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_form_view": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_form_view_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_form_view_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_form_view_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_form_view_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_lead": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_lead_copy": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_lead_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_lead_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_lead_private": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_lead_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_lead_types": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - All, 2 - Selected", "example": 1, "enum": [1, 2]}, "access_entity_message_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_oppty": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_oppty_copy": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_oppty_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_oppty_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_oppty_private": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_oppty_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_pipeline": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoPipeline, 1 - Selected, 2 - AllNoDocuments, 3 - AllWithDocuments", "example": 0, "enum": [0, 1, 2, 3]}, "access_entity_process": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess", "example": 1, "enum": [1, 2, 3]}, "access_entity_profile": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_profile_default_screen_profiles": {"type": "object", "description": "Default screen profile ids assigned to users with this role for each main screen (Navigator, Pipeline, Lead, Account, Contact, Activity, Project, Quote, etc.)."}, "access_entity_profile_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_profile_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_profile_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_profile_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_project": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_project_copy": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_project_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_project_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_project_private": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_project_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_quote": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_quote_copy": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_quote_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_quote_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_quote_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_quote_types": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - All, 2 - Selected", "example": 1, "enum": [1, 2]}, "access_entity_report": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_report_create_delete_folder": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_private": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_schedule_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_schedule_management": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_target": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_target_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_target_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_task": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_task_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_task_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_task_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_task_unassigned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_export": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_feeds": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_foreign_currencies": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_form_and_fields": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_global_settings": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_home_screen": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_import": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_insights": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_leads": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_online_forms": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_online_forms_management": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_opportunity": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_pipeline_configuration": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_print": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_products_services": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_projects": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_quotes": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_sales_roles": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_security": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_units": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_user_and_roles": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_whats_app_company_phone": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Selected, 2 - All", "example": 0, "enum": [0, 1, 2]}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "allowed_pipelines": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to AllowedPipeline. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AllowedPipeline' object for properties."}, "description": "Pipelines this user role can use. Effective only when access_entity_pipeline is set to Selected; with All-* values every pipeline is granted."}, "allowed_lead_types": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to AllowedLeadType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AllowedLeadType' object for properties."}, "description": "Lead types this user role can use. Effective only when access_entity_lead_types is set to Selected."}, "allowed_quote_types": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to AllowedQuoteType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AllowedQuoteType' object for properties."}, "description": "Quote types this user role can use. Effective only when access_entity_quote_types is set to Selected."}, "allowed_account_types": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to AllowedAccountType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AllowedAccountType' object for properties."}, "description": "Account types this user role can use. Effective only when access_entity_account_types is set to Selected."}, "allowed_contact_types": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to AllowedContactType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AllowedContactType' object for properties."}, "description": "Contact types this user role can use. Effective only when access_entity_contact_types is set to Selected."}, "allowed_company_emails": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to AllowedCompanyEmail. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AllowedCompanyEmail' object for properties."}, "description": "Company email addresses this user role can send from. Effective only when access_company_emails is set to Selected."}, "allowed_company_phones": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to AllowedCompanyPhone. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AllowedCompanyPhone' object for properties."}, "description": "Company phones this user role can use for calling/SMS. Effective only when access_calling_company_phone is set to Selected."}, "custom_entities": {"type": "string", "format": "binary", "example": "blob", "description": "Per-custom-entity access settings (access level, allowed types, default screen profile, etc.) for users with this role. One entry per custom entity defined in the space."}}, "required": ["is_delete_protected", "id", "name"]}, "createMasterRightInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "access_account_relation_types": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_accounts": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_automatizer": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_online_forms": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_record_detail": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_record_enrichment": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_relationship_charts": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_reports": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_smart_field": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_appointment_scheduler": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_appointment_scheduler_management": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_approval_processes": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_approval_processes_management": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_approvals": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_archive": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_audit": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_audit_log": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_bulk_update": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_calling": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_calling_company_phone": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Selected, 2 - All", "example": 0, "enum": [0, 1, 2]}, "access_calling_purchase_phone": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_company_emails": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Selected, 2 - All", "example": 0, "enum": [0, 1, 2]}, "access_contacts": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_document_management": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_document_management_company": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_document_management_record": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_duplicate_checker": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_email_notification_enforcement": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_email_notification_settings": {"type": "object", "description": "Default email notification preferences applied to users with this role (which events trigger an email and through which channel)."}, "access_entity_account": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_account_copy": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_account_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_account_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_account_private": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_account_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_account_types": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - All, 2 - Selected", "example": 1, "enum": [1, 2]}, "access_entity_appointment": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_appointment_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_appointment_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_appointment_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_better_navigator": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_better_navigator_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_better_navigator_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_better_navigator_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_better_navigator_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_contact": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_contact_copy": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_contact_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_contact_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_contact_private": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_contact_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_contact_types": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - All, 2 - Selected", "example": 1, "enum": [1, 2]}, "access_entity_dashboard": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_dashboard_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_dashboard_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_dashboard_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_dashboard_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_email_content_share_mode": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - PrivateOnly, 1 - Custom, 2 - PublicOnly", "example": 0, "enum": [0, 1, 2]}, "access_entity_email_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_email_sequence": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess", "example": 1, "enum": [1, 2, 3]}, "access_entity_email_template": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_email_template_create_delete_folder": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_email_template_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_email_template_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_email_template_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_email_template_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_forecast": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_forecast_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_forecast_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_forecast_edit_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_forecast_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_forecast_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_form_view": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_form_view_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_form_view_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_form_view_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_form_view_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_lead": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_lead_copy": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_lead_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_lead_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_lead_private": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_lead_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_lead_types": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - All, 2 - Selected", "example": 1, "enum": [1, 2]}, "access_entity_message_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_oppty": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_oppty_copy": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_oppty_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_oppty_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_oppty_private": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_oppty_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_pipeline": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoPipeline, 1 - Selected, 2 - AllNoDocuments, 3 - AllWithDocuments", "example": 0, "enum": [0, 1, 2, 3]}, "access_entity_process": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess", "example": 1, "enum": [1, 2, 3]}, "access_entity_profile": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_profile_default_screen_profiles": {"type": "object", "description": "Default screen profile ids assigned to users with this role for each main screen (Navigator, Pipeline, Lead, Account, Contact, Activity, Project, Quote, etc.)."}, "access_entity_profile_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_profile_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_profile_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_profile_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_project": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_project_copy": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_project_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_project_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_project_private": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_project_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_quote": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_quote_copy": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_quote_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_quote_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_quote_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_quote_types": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - All, 2 - Selected", "example": 1, "enum": [1, 2]}, "access_entity_report": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_report_create_delete_folder": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_private": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_schedule_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_schedule_management": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_target": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_target_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_target_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_task": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_task_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_task_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_task_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_task_unassigned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_export": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_feeds": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_foreign_currencies": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_form_and_fields": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_global_settings": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_home_screen": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_import": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_insights": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_leads": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_online_forms": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_online_forms_management": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_opportunity": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_pipeline_configuration": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_print": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_products_services": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_projects": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_quotes": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_sales_roles": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_security": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_units": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_user_and_roles": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_whats_app_company_phone": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Selected, 2 - All", "example": 0, "enum": [0, 1, 2]}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "allowed_pipelines": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AllowedPipeline, see: 'createAllowedPipelineInput' object for properties."}, "description": "Pipelines this user role can use. Effective only when access_entity_pipeline is set to Selected; with All-* values every pipeline is granted."}, "allowed_lead_types": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AllowedLeadType, see: 'createAllowedLeadTypeInput' object for properties."}, "description": "Lead types this user role can use. Effective only when access_entity_lead_types is set to Selected."}, "allowed_quote_types": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AllowedQuoteType, see: 'createAllowedQuoteTypeInput' object for properties."}, "description": "Quote types this user role can use. Effective only when access_entity_quote_types is set to Selected."}, "allowed_account_types": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AllowedAccountType, see: 'createAllowedAccountTypeInput' object for properties."}, "description": "Account types this user role can use. Effective only when access_entity_account_types is set to Selected."}, "allowed_contact_types": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AllowedContactType, see: 'createAllowedContactTypeInput' object for properties."}, "description": "Contact types this user role can use. Effective only when access_entity_contact_types is set to Selected."}, "allowed_company_emails": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AllowedCompanyEmail, see: 'createAllowedCompanyEmailInput' object for properties."}, "description": "Company email addresses this user role can send from. Effective only when access_company_emails is set to Selected."}, "allowed_company_phones": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AllowedCompanyPhone, see: 'createAllowedCompanyPhoneInput' object for properties."}, "description": "Company phones this user role can use for calling/SMS. Effective only when access_calling_company_phone is set to Selected."}, "custom_entities": {"type": "string", "format": "binary", "example": "blob", "description": "Per-custom-entity access settings (access level, allowed types, default screen profile, etc.) for users with this role. One entry per custom entity defined in the space."}}, "required": ["name"]}, "updateMasterRightInput": {"properties": {"access_account_relation_types": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_accounts": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_automatizer": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_online_forms": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_record_detail": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_record_enrichment": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_relationship_charts": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_reports": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_smart_field": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_appointment_scheduler": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_appointment_scheduler_management": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_approval_processes": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_approval_processes_management": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_approvals": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_archive": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_audit": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_audit_log": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_bulk_update": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_calling": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_calling_company_phone": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Selected, 2 - All", "example": 0, "enum": [0, 1, 2]}, "access_calling_purchase_phone": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_company_emails": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Selected, 2 - All", "example": 0, "enum": [0, 1, 2]}, "access_contacts": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_document_management": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_document_management_company": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_document_management_record": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_duplicate_checker": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_email_notification_enforcement": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_email_notification_settings": {"type": "object", "description": "Default email notification preferences applied to users with this role (which events trigger an email and through which channel)."}, "access_entity_account": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_account_copy": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_account_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_account_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_account_private": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_account_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_account_types": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - All, 2 - Selected", "example": 1, "enum": [1, 2]}, "access_entity_appointment": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_appointment_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_appointment_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_appointment_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_better_navigator": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_better_navigator_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_better_navigator_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_better_navigator_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_better_navigator_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_contact": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_contact_copy": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_contact_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_contact_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_contact_private": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_contact_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_contact_types": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - All, 2 - Selected", "example": 1, "enum": [1, 2]}, "access_entity_dashboard": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_dashboard_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_dashboard_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_dashboard_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_dashboard_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_email_content_share_mode": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - PrivateOnly, 1 - Custom, 2 - PublicOnly", "example": 0, "enum": [0, 1, 2]}, "access_entity_email_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_email_sequence": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess", "example": 1, "enum": [1, 2, 3]}, "access_entity_email_template": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_email_template_create_delete_folder": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_email_template_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_email_template_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_email_template_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_email_template_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_forecast": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_forecast_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_forecast_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_forecast_edit_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_forecast_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_forecast_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_form_view": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_form_view_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_form_view_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_form_view_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_form_view_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_lead": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_lead_copy": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_lead_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_lead_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_lead_private": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_lead_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_lead_types": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - All, 2 - Selected", "example": 1, "enum": [1, 2]}, "access_entity_message_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_oppty": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_oppty_copy": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_oppty_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_oppty_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_oppty_private": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_oppty_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_pipeline": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoPipeline, 1 - Selected, 2 - AllNoDocuments, 3 - AllWithDocuments", "example": 0, "enum": [0, 1, 2, 3]}, "access_entity_process": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess", "example": 1, "enum": [1, 2, 3]}, "access_entity_profile": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_profile_default_screen_profiles": {"type": "object", "description": "Default screen profile ids assigned to users with this role for each main screen (Navigator, Pipeline, Lead, Account, Contact, Activity, Project, Quote, etc.)."}, "access_entity_profile_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_profile_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_profile_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_profile_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_project": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_project_copy": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_project_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_project_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_project_private": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_project_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_quote": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_quote_copy": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_quote_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_quote_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_quote_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_quote_types": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - All, 2 - Selected", "example": 1, "enum": [1, 2]}, "access_entity_report": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_report_create_delete_folder": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_private": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_schedule_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_schedule_management": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_target": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_target_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_target_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_task": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_task_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_task_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_task_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_task_unassigned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_export": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_feeds": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_foreign_currencies": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_form_and_fields": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_global_settings": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_home_screen": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_import": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_insights": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_leads": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_online_forms": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_online_forms_management": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_opportunity": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_pipeline_configuration": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_print": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_products_services": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_projects": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_quotes": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_sales_roles": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_security": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_units": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_user_and_roles": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_whats_app_company_phone": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Selected, 2 - All", "example": 0, "enum": [0, 1, 2]}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "allowed_pipelines": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AllowedPipeline, see: 'updateAllowedPipelineInput' object for properties."}, "description": "Pipelines this user role can use. Effective only when access_entity_pipeline is set to Selected; with All-* values every pipeline is granted."}, "allowed_lead_types": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AllowedLeadType, see: 'updateAllowedLeadTypeInput' object for properties."}, "description": "Lead types this user role can use. Effective only when access_entity_lead_types is set to Selected."}, "allowed_quote_types": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AllowedQuoteType, see: 'updateAllowedQuoteTypeInput' object for properties."}, "description": "Quote types this user role can use. Effective only when access_entity_quote_types is set to Selected."}, "allowed_account_types": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AllowedAccountType, see: 'updateAllowedAccountTypeInput' object for properties."}, "description": "Account types this user role can use. Effective only when access_entity_account_types is set to Selected."}, "allowed_contact_types": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AllowedContactType, see: 'updateAllowedContactTypeInput' object for properties."}, "description": "Contact types this user role can use. Effective only when access_entity_contact_types is set to Selected."}, "allowed_company_emails": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AllowedCompanyEmail, see: 'updateAllowedCompanyEmailInput' object for properties."}, "description": "Company email addresses this user role can send from. Effective only when access_company_emails is set to Selected."}, "allowed_company_phones": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AllowedCompanyPhone, see: 'updateAllowedCompanyPhoneInput' object for properties."}, "description": "Company phones this user role can use for calling/SMS. Effective only when access_calling_company_phone is set to Selected."}, "custom_entities": {"type": "string", "format": "binary", "example": "blob", "description": "Per-custom-entity access settings (access level, allowed types, default screen profile, etc.) for users with this role. One entry per custom entity defined in the space."}}}, "batchMasterRightInput": {"properties": {"access_account_relation_types": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_accounts": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_automatizer": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_online_forms": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_record_detail": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_record_enrichment": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_relationship_charts": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_reports": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_ai_smart_field": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_appointment_scheduler": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_appointment_scheduler_management": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_approval_processes": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_approval_processes_management": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_approvals": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_archive": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_audit": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_audit_log": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_bulk_update": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_calling": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_calling_company_phone": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Selected, 2 - All", "example": 0, "enum": [0, 1, 2]}, "access_calling_purchase_phone": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_company_emails": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Selected, 2 - All", "example": 0, "enum": [0, 1, 2]}, "access_contacts": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_document_management": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_document_management_company": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_document_management_record": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_duplicate_checker": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_email_notification_enforcement": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_email_notification_settings": {"type": "object", "description": "Default email notification preferences applied to users with this role (which events trigger an email and through which channel)."}, "access_entity_account": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_account_copy": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_account_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_account_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_account_private": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_account_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_account_types": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - All, 2 - Selected", "example": 1, "enum": [1, 2]}, "access_entity_appointment": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_appointment_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_appointment_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_appointment_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_better_navigator": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_better_navigator_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_better_navigator_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_better_navigator_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_better_navigator_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_contact": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_contact_copy": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_contact_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_contact_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_contact_private": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_contact_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_contact_types": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - All, 2 - Selected", "example": 1, "enum": [1, 2]}, "access_entity_dashboard": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_dashboard_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_dashboard_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_dashboard_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_dashboard_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_email_content_share_mode": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - PrivateOnly, 1 - Custom, 2 - PublicOnly", "example": 0, "enum": [0, 1, 2]}, "access_entity_email_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_email_sequence": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess", "example": 1, "enum": [1, 2, 3]}, "access_entity_email_template": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_email_template_create_delete_folder": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_email_template_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_email_template_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_email_template_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_email_template_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_forecast": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_forecast_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_forecast_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_forecast_edit_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_forecast_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_forecast_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_form_view": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_form_view_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_form_view_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_form_view_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_form_view_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_lead": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_lead_copy": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_lead_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_lead_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_lead_private": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_lead_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_lead_types": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - All, 2 - Selected", "example": 1, "enum": [1, 2]}, "access_entity_message_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_oppty": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_oppty_copy": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_oppty_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_oppty_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_oppty_private": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_oppty_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_pipeline": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoPipeline, 1 - Selected, 2 - AllNoDocuments, 3 - AllWithDocuments", "example": 0, "enum": [0, 1, 2, 3]}, "access_entity_process": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess", "example": 1, "enum": [1, 2, 3]}, "access_entity_profile": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_profile_default_screen_profiles": {"type": "object", "description": "Default screen profile ids assigned to users with this role for each main screen (Navigator, Pipeline, Lead, Account, Contact, Activity, Project, Quote, etc.)."}, "access_entity_profile_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_profile_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_profile_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_profile_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_project": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_project_copy": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_project_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_project_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_project_private": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_project_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_quote": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_quote_copy": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_quote_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_quote_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_quote_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_quote_types": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - All, 2 - Selected", "example": 1, "enum": [1, 2]}, "access_entity_report": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_report_create_delete_folder": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_private": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_schedule_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_schedule_management": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_sharing_custom": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_report_sharing_public": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_target": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "example": 0, "enum": [0, 1, 4]}, "access_entity_target_delete_not_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_target_delete_owned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_task": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "example": 0, "enum": [0, 1, 2, 3, 4]}, "access_entity_task_delete": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_task_direction": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "access_entity_task_tag_create": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_entity_task_unassigned": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_export": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_feeds": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_foreign_currencies": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_form_and_fields": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_global_settings": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_home_screen": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_import": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_insights": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_leads": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_online_forms": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_online_forms_management": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_opportunity": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_pipeline_configuration": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_print": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_products_services": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_projects": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_quotes": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_sales_roles": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_security": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_units": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_user_and_roles": {"type": "boolean", "example": false, "description": "Controls access to resource."}, "access_whats_app_company_phone": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Selected, 2 - All", "example": 0, "enum": [0, 1, 2]}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "allowed_pipelines": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AllowedPipeline, see: 'updateAllowedPipelineInput' object for properties."}, "description": "Pipelines this user role can use. Effective only when access_entity_pipeline is set to Selected; with All-* values every pipeline is granted."}, "allowed_lead_types": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AllowedLeadType, see: 'updateAllowedLeadTypeInput' object for properties."}, "description": "Lead types this user role can use. Effective only when access_entity_lead_types is set to Selected."}, "allowed_quote_types": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AllowedQuoteType, see: 'updateAllowedQuoteTypeInput' object for properties."}, "description": "Quote types this user role can use. Effective only when access_entity_quote_types is set to Selected."}, "allowed_account_types": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AllowedAccountType, see: 'updateAllowedAccountTypeInput' object for properties."}, "description": "Account types this user role can use. Effective only when access_entity_account_types is set to Selected."}, "allowed_contact_types": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AllowedContactType, see: 'updateAllowedContactTypeInput' object for properties."}, "description": "Contact types this user role can use. Effective only when access_entity_contact_types is set to Selected."}, "allowed_company_emails": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AllowedCompanyEmail, see: 'updateAllowedCompanyEmailInput' object for properties."}, "description": "Company email addresses this user role can send from. Effective only when access_company_emails is set to Selected."}, "allowed_company_phones": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to AllowedCompanyPhone, see: 'updateAllowedCompanyPhoneInput' object for properties."}, "description": "Company phones this user role can use for calling/SMS. Effective only when access_calling_company_phone is set to Selected."}, "custom_entities": {"type": "string", "format": "binary", "example": "blob", "description": "Per-custom-entity access settings (access level, allowed types, default screen profile, etc.) for users with this role. One entry per custom entity defined in the space."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Media": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "appointment": {"type": "string", "format": "uri", "description": "Appointment this media is attached to. Set when activity_id resolves to an Appointment.\n\nRelation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties."}, "task": {"type": "string", "format": "uri", "description": "Task this media is attached to. Set when activity_id resolves to a Task.\n\nRelation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties."}, "call": {"type": "string", "format": "uri", "description": "Call this media belongs to (e.g. a recording or transcription).\n\nRelation to Call. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Call' object for properties."}, "activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked appointment or task, or empty when not linked to an activity."}, "call_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked call, or empty when not linked."}, "data": {"type": "object", "description": "Provider-specific metadata about the media (e.g. transcription identifiers, recording parameters), as a JSON object."}, "description": {"type": "string", "example": "string", "description": "Free-text description of the media."}, "error_code": {"type": "integer", "format": "int32", "example": 1, "description": "Error code reported by the calling/recording provider when processing failed; empty on success."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - NoRecording, 2 - Uploading, 3 - Uploaded, 4 - Transcoding, 5 - TranscriptionInProgress, 6 - TranscriptionCompleted", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Audio, 2 - Video, 3 - Transcription", "example": 1, "enum": [1, 2, 3]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "audio_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the cloud object holding the audio recording, when available."}, "transcription_file_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the cloud object holding the transcription payload, when available."}, "transcription_id": {"type": "string", "example": "string", "description": "External transcription identifier from the calling provider."}, "transcription_language": {"type": "string", "example": "string", "description": "Language requested for the transcription as a BCP-47 locale tag (e.g. \"en-US\", \"de-DE\"). Set when the transcription was requested."}, "transcription_summary": {"type": "string", "example": "string", "description": "AI-generated summary of the transcription content."}, "get_transcription_viewer_token": {"type": "string", "example": "string", "description": "Short-lived token for opening the transcription in the calling provider's viewer. Empty when no transcription is available."}}, "required": ["is_delete_protected", "id", "transcription_id", "transcription_language", "transcription_summary", "get_transcription_viewer_token"]}, "createMediaInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked appointment or task, or empty when not linked to an activity."}, "call_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked call, or empty when not linked."}, "data": {"type": "object", "description": "Provider-specific metadata about the media (e.g. transcription identifiers, recording parameters), as a JSON object."}, "description": {"type": "string", "example": "string", "description": "Free-text description of the media."}, "error_code": {"type": "integer", "format": "int32", "example": 1, "description": "Error code reported by the calling/recording provider when processing failed; empty on success."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - NoRecording, 2 - Uploading, 3 - Uploaded, 4 - Transcoding, 5 - TranscriptionInProgress, 6 - TranscriptionCompleted", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Audio, 2 - Video, 3 - Transcription", "example": 1, "enum": [1, 2, 3]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "updateMediaInput": {"properties": {"activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked appointment or task, or empty when not linked to an activity."}, "call_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked call, or empty when not linked."}, "data": {"type": "object", "description": "Provider-specific metadata about the media (e.g. transcription identifiers, recording parameters), as a JSON object."}, "description": {"type": "string", "example": "string", "description": "Free-text description of the media."}, "error_code": {"type": "integer", "format": "int32", "example": 1, "description": "Error code reported by the calling/recording provider when processing failed; empty on success."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - NoRecording, 2 - Uploading, 3 - Uploaded, 4 - Transcoding, 5 - TranscriptionInProgress, 6 - TranscriptionCompleted", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Audio, 2 - Video, 3 - Transcription", "example": 1, "enum": [1, 2, 3]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchMediaInput": {"properties": {"activity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked appointment or task, or empty when not linked to an activity."}, "call_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked call, or empty when not linked."}, "data": {"type": "object", "description": "Provider-specific metadata about the media (e.g. transcription identifiers, recording parameters), as a JSON object."}, "description": {"type": "string", "example": "string", "description": "Free-text description of the media."}, "error_code": {"type": "integer", "format": "int32", "example": 1, "description": "Error code reported by the calling/recording provider when processing failed; empty on success."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - NoRecording, 2 - Uploading, 3 - Uploaded, 4 - Transcoding, 5 - TranscriptionInProgress, 6 - TranscriptionCompleted", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Audio, 2 - Video, 3 - Transcription", "example": 1, "enum": [1, 2, 3]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Memo": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "owner": {"type": "string", "format": "uri", "description": "User who authored the memo.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the memo author."}, "subject": {"type": "string", "example": "string", "description": "Short summary line of the memo."}, "table_name": {"type": "string", "example": "string", "description": "Discriminator identifying the concrete record type \u2014 always \"memo\" for Memo records. Read-only; useful when consuming polymorphic Message results.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sharing_units": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to MessageSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageSharingSalesUnitRelation' object for properties."}, "description": "Sales units that have been granted shared access to this memo."}, "sharing_clients": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to MessageSharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageSharingClientRelation' object for properties."}, "description": "Users that have been granted shared access to this memo."}, "account_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties."}, "description": "Accounts this memo is linked to."}, "contact_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties."}, "description": "Contacts this memo is linked to."}, "project_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties."}, "description": "Projects this memo is linked to."}, "lead_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties."}, "description": "Leads this memo is linked to."}, "quote_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties."}, "description": "Quotes this memo is linked to."}, "opportunity_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties."}, "description": "Opportunities this memo is linked to."}, "custom_entity_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties."}, "description": "Custom entity records this memo is linked to."}, "documents": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties."}, "description": "Documents linked to this memo."}, "comments": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to MemoComment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MemoComment' object for properties."}, "description": "Comments authored on this memo."}}, "required": ["is_delete_protected", "id", "owner", "owner_id", "subject", "table_name"]}, "createMemoInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the memo author."}, "subject": {"type": "string", "example": "string", "description": "Short summary line of the memo."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageSharingSalesUnitRelation, see: 'createMessageSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this memo."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageSharingClientRelation, see: 'createMessageSharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this memo."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'createMessageRelationInput' object for properties."}, "description": "Accounts this memo is linked to."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'createMessageRelationInput' object for properties."}, "description": "Contacts this memo is linked to."}, "project_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'createMessageRelationInput' object for properties."}, "description": "Projects this memo is linked to."}, "lead_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'createMessageRelationInput' object for properties."}, "description": "Leads this memo is linked to."}, "quote_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'createMessageRelationInput' object for properties."}, "description": "Quotes this memo is linked to."}, "opportunity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'createMessageRelationInput' object for properties."}, "description": "Opportunities this memo is linked to."}, "custom_entity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'createMessageRelationInput' object for properties."}, "description": "Custom entity records this memo is linked to."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this memo."}, "comments": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MemoComment, see: 'createMemoCommentInput' object for properties."}, "description": "Comments authored on this memo."}}, "required": ["owner_id", "subject"]}, "updateMemoInput": {"properties": {"owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the memo author."}, "subject": {"type": "string", "example": "string", "description": "Short summary line of the memo."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageSharingSalesUnitRelation, see: 'updateMessageSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this memo."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageSharingClientRelation, see: 'updateMessageSharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this memo."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Accounts this memo is linked to."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Contacts this memo is linked to."}, "project_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Projects this memo is linked to."}, "lead_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Leads this memo is linked to."}, "quote_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Quotes this memo is linked to."}, "opportunity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Opportunities this memo is linked to."}, "custom_entity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Custom entity records this memo is linked to."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this memo."}, "comments": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MemoComment, see: 'updateMemoCommentInput' object for properties."}, "description": "Comments authored on this memo."}}}, "batchMemoInput": {"properties": {"owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the memo author."}, "subject": {"type": "string", "example": "string", "description": "Short summary line of the memo."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageSharingSalesUnitRelation, see: 'updateMessageSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this memo."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageSharingClientRelation, see: 'updateMessageSharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this memo."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Accounts this memo is linked to."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Contacts this memo is linked to."}, "project_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Projects this memo is linked to."}, "lead_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Leads this memo is linked to."}, "quote_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Quotes this memo is linked to."}, "opportunity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Opportunities this memo is linked to."}, "custom_entity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MessageRelation, see: 'updateMessageRelationInput' object for properties."}, "description": "Custom entity records this memo is linked to."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this memo."}, "comments": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to MemoComment, see: 'updateMemoCommentInput' object for properties."}, "description": "Comments authored on this memo."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "MemoComment": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "memo": {"type": "string", "format": "uri", "description": "Memo this comment belongs to.\n\nRelation to Memo. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Memo' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "User who authored the comment.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "comment": {"type": "string", "example": "string", "description": "Free-form text body of the comment."}, "memo_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the memo."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the comment author."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "memo", "owner", "comment", "memo_id", "owner_id"]}, "createMemoCommentInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "comment": {"type": "string", "example": "string", "description": "Free-form text body of the comment."}, "memo_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the memo."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the comment author."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["comment", "memo_id", "owner_id"]}, "updateMemoCommentInput": {"properties": {"comment": {"type": "string", "example": "string", "description": "Free-form text body of the comment."}, "memo_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the memo."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the comment author."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchMemoCommentInput": {"properties": {"comment": {"type": "string", "example": "string", "description": "Free-form text body of the comment."}, "memo_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the memo."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the comment author."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "MessageRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account": {"type": "string", "format": "uri", "description": "Account the message is linked to, or empty when not linked to an account.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "contact": {"type": "string", "format": "uri", "description": "Contact the message is linked to, or empty when not linked to a contact.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "custom_entity": {"type": "string", "format": "uri", "description": "Custom entity record the message is linked to, or empty when not linked.\n\nRelation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties."}, "lead": {"type": "string", "format": "uri", "description": "Lead the message is linked to. Set when lead_oppty_id resolves to a Lead; otherwise empty.\n\nRelation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties."}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity the message is linked to. Set when lead_oppty_id resolves to an Opportunity; otherwise empty.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "email": {"type": "string", "format": "uri", "description": "Email side of the link. Set when message_id resolves to an Email; otherwise empty.\n\nRelation to Email. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Email' object for properties."}, "memo": {"type": "string", "format": "uri", "description": "Memo side of the link. Set when message_id resolves to a Memo; otherwise empty.\n\nRelation to Memo. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Memo' object for properties."}, "project": {"type": "string", "format": "uri", "description": "Project the message is linked to, or empty when not linked.\n\nRelation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties."}, "quote": {"type": "string", "format": "uri", "description": "Quote the message is linked to, or empty when not linked.\n\nRelation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity the message is linked to, or empty when not linked."}, "message_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email or memo on this link."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "message_id"]}, "createMessageRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity the message is linked to, or empty when not linked."}, "message_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email or memo on this link."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["message_id"]}, "updateMessageRelationInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity the message is linked to, or empty when not linked."}, "message_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email or memo on this link."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchMessageRelationInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity the message is linked to, or empty when not linked."}, "message_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email or memo on this link."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "MessageSharingClientRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client": {"type": "string", "format": "uri", "description": "User the message is shared with.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "email": {"type": "string", "format": "uri", "description": "Email being shared. Set when message_id resolves to an Email; otherwise empty.\n\nRelation to Email. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Email' object for properties."}, "memo": {"type": "string", "format": "uri", "description": "Memo being shared. Set when message_id resolves to a Memo; otherwise empty.\n\nRelation to Memo. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Memo' object for properties."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "message_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email or memo being shared."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "client", "client_id", "message_id"]}, "createMessageSharingClientRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "message_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email or memo being shared."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["client_id", "message_id"]}, "updateMessageSharingClientRelationInput": {"properties": {"client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "message_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email or memo being shared."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchMessageSharingClientRelationInput": {"properties": {"client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "message_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email or memo being shared."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "MessageSharingSalesUnitRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "email": {"type": "string", "format": "uri", "description": "Email being shared. Set when message_id resolves to an Email; otherwise empty.\n\nRelation to Email. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Email' object for properties."}, "memo": {"type": "string", "format": "uri", "description": "Memo being shared. Set when message_id resolves to a Memo; otherwise empty.\n\nRelation to Memo. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Memo' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit the message is shared with.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "message_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email or memo being shared."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "unit", "message_id", "unit_id"]}, "createMessageSharingSalesUnitRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "message_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email or memo being shared."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["message_id", "unit_id"]}, "updateMessageSharingSalesUnitRelationInput": {"properties": {"message_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email or memo being shared."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchMessageSharingSalesUnitRelationInput": {"properties": {"message_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email or memo being shared."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Note": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account": {"type": "string", "format": "uri", "description": "Account the note is attached to. Exactly one of account / contact / lead_oppty / project / quote / custom_entity must be set.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "contact": {"type": "string", "format": "uri", "description": "Contact the note is attached to.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "custom_entity": {"type": "string", "format": "uri", "description": "Custom entity record the note is attached to.\n\nRelation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties."}, "lead": {"type": "string", "format": "uri", "description": "Lead the note is attached to. Set when lead_oppty_id resolves to a Lead.\n\nRelation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties."}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity the note is attached to. Set when lead_oppty_id resolves to an Opportunity.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "User who authored the note.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "project": {"type": "string", "format": "uri", "description": "Project the note is attached to.\n\nRelation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties."}, "quote": {"type": "string", "format": "uri", "description": "Quote the note is attached to.\n\nRelation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the custom entity record."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity the note is attached to."}, "note": {"type": "string", "example": "string", "description": "Free-form text body of the note (sanitized HTML allowed)."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the note author."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "owner", "note", "owner_id"]}, "createNoteInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the custom entity record."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity the note is attached to."}, "note": {"type": "string", "example": "string", "description": "Free-form text body of the note (sanitized HTML allowed)."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the note author."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["note", "owner_id"]}, "updateNoteInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the custom entity record."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity the note is attached to."}, "note": {"type": "string", "example": "string", "description": "Free-form text body of the note (sanitized HTML allowed)."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the note author."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchNoteInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the custom entity record."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity the note is attached to."}, "note": {"type": "string", "example": "string", "description": "Free-form text body of the note (sanitized HTML allowed)."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the note author."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "OnlineForm": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "currency_exchange_rates_list": {"type": "string", "format": "uri", "description": "Currency exchange rate list applied to product line-items at submission time.\n\nRelation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRatesList' object for properties."}, "email": {"type": "string", "format": "uri", "description": "Email submitted with the response, used for identification or response notifications.\n\nRelation to Email. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Email' object for properties."}, "online_form_type": {"type": "string", "format": "uri", "description": "Online form definition this submission belongs to.\n\nRelation to OnlineFormType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineFormType' object for properties."}, "product_currency": {"type": "string", "format": "uri", "description": "Currency selected by the respondent for product line-items, when the form contains products.\n\nRelation to Currency. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Currency' object for properties."}, "product_price_list": {"type": "string", "format": "uri", "description": "Product price list selected by the respondent, when the form contains products.\n\nRelation to ProductPriceList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProductPriceList' object for properties."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the exchange rate list."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked email record, when available."}, "field_ids": {"type": "object", "description": "Ids of the fields included in the form when this submission was captured, as a JSON array of field ids (UUIDs)."}, "online_form_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form definition."}, "product_currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the selected currency."}, "product_price_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the selected price list."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "account_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to OnlineFormRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineFormRelation' object for properties."}, "description": "Accounts the submission was linked to."}, "contact_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to OnlineFormRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineFormRelation' object for properties."}, "description": "Contacts the submission was linked to."}, "lead_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to OnlineFormRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineFormRelation' object for properties."}, "description": "Leads the submission was linked to."}, "opportunity_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to OnlineFormRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineFormRelation' object for properties."}, "description": "Opportunities the submission was linked to."}, "quote_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to OnlineFormRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineFormRelation' object for properties."}, "description": "Quotes the submission was linked to."}, "project_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to OnlineFormRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineFormRelation' object for properties."}, "description": "Projects the submission was linked to."}, "custom_entity_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to OnlineFormRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineFormRelation' object for properties."}, "description": "Custom entity records the submission was linked to."}, "lines": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to OnlineFormActivityLogLine. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineFormActivityLogLine' object for properties."}, "description": "Activity log lines describing what was done with this submission (visible only)."}, "responded_by": {"type": "string", "example": "string", "description": "Display name of the primary record (account/contact/lead/...) the submission was linked to."}, "response_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the submission was received (the response was completed)."}}, "required": ["is_delete_protected", "id", "online_form_type", "product_currency", "field_ids", "online_form_type_id", "responded_by"]}, "createOnlineFormInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the exchange rate list."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked email record, when available."}, "field_ids": {"type": "object", "description": "Ids of the fields included in the form when this submission was captured, as a JSON array of field ids (UUIDs)."}, "online_form_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form definition."}, "product_currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the selected currency."}, "product_price_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the selected price list."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OnlineFormRelation, see: 'createOnlineFormRelationInput' object for properties."}, "description": "Accounts the submission was linked to."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OnlineFormRelation, see: 'createOnlineFormRelationInput' object for properties."}, "description": "Contacts the submission was linked to."}, "lead_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OnlineFormRelation, see: 'createOnlineFormRelationInput' object for properties."}, "description": "Leads the submission was linked to."}, "opportunity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OnlineFormRelation, see: 'createOnlineFormRelationInput' object for properties."}, "description": "Opportunities the submission was linked to."}, "quote_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OnlineFormRelation, see: 'createOnlineFormRelationInput' object for properties."}, "description": "Quotes the submission was linked to."}, "project_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OnlineFormRelation, see: 'createOnlineFormRelationInput' object for properties."}, "description": "Projects the submission was linked to."}, "custom_entity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OnlineFormRelation, see: 'createOnlineFormRelationInput' object for properties."}, "description": "Custom entity records the submission was linked to."}}, "required": ["field_ids", "online_form_type_id"]}, "updateOnlineFormInput": {"properties": {"currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the exchange rate list."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked email record, when available."}, "field_ids": {"type": "object", "description": "Ids of the fields included in the form when this submission was captured, as a JSON array of field ids (UUIDs)."}, "online_form_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form definition."}, "product_currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the selected currency."}, "product_price_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the selected price list."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OnlineFormRelation, see: 'updateOnlineFormRelationInput' object for properties."}, "description": "Accounts the submission was linked to."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OnlineFormRelation, see: 'updateOnlineFormRelationInput' object for properties."}, "description": "Contacts the submission was linked to."}, "lead_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OnlineFormRelation, see: 'updateOnlineFormRelationInput' object for properties."}, "description": "Leads the submission was linked to."}, "opportunity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OnlineFormRelation, see: 'updateOnlineFormRelationInput' object for properties."}, "description": "Opportunities the submission was linked to."}, "quote_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OnlineFormRelation, see: 'updateOnlineFormRelationInput' object for properties."}, "description": "Quotes the submission was linked to."}, "project_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OnlineFormRelation, see: 'updateOnlineFormRelationInput' object for properties."}, "description": "Projects the submission was linked to."}, "custom_entity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OnlineFormRelation, see: 'updateOnlineFormRelationInput' object for properties."}, "description": "Custom entity records the submission was linked to."}}}, "batchOnlineFormInput": {"properties": {"currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the exchange rate list."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked email record, when available."}, "field_ids": {"type": "object", "description": "Ids of the fields included in the form when this submission was captured, as a JSON array of field ids (UUIDs)."}, "online_form_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form definition."}, "product_currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the selected currency."}, "product_price_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the selected price list."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OnlineFormRelation, see: 'updateOnlineFormRelationInput' object for properties."}, "description": "Accounts the submission was linked to."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OnlineFormRelation, see: 'updateOnlineFormRelationInput' object for properties."}, "description": "Contacts the submission was linked to."}, "lead_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OnlineFormRelation, see: 'updateOnlineFormRelationInput' object for properties."}, "description": "Leads the submission was linked to."}, "opportunity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OnlineFormRelation, see: 'updateOnlineFormRelationInput' object for properties."}, "description": "Opportunities the submission was linked to."}, "quote_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OnlineFormRelation, see: 'updateOnlineFormRelationInput' object for properties."}, "description": "Quotes the submission was linked to."}, "project_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OnlineFormRelation, see: 'updateOnlineFormRelationInput' object for properties."}, "description": "Projects the submission was linked to."}, "custom_entity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OnlineFormRelation, see: 'updateOnlineFormRelationInput' object for properties."}, "description": "Custom entity records the submission was linked to."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "OnlineFormActivityLogLine": {"properties": {"formatted_text": {"type": "string", "example": "string", "description": "Human-readable rendering of the log line, prefixed with the line's timestamp and (when applicable) the parent record id."}, "is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "online_form": {"type": "string", "format": "uri", "description": "Online form submission this log line belongs to.\n\nRelation to OnlineForm. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineForm' object for properties."}, "executed_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run."}, "is_visible": {"type": "boolean", "example": false, "description": "True when the line is shown in the activity log UI; false for internal-only lines."}, "online_form_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the submission."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the line within its log run."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}}, "required": ["formatted_text", "is_delete_protected", "id", "online_form", "online_form_id", "sort_order"]}, "createOnlineFormActivityLogLineInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "executed_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run."}, "is_visible": {"type": "boolean", "example": false, "description": "True when the line is shown in the activity log UI; false for internal-only lines."}, "online_form_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the submission."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the line within its log run."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}}, "required": ["online_form_id", "sort_order"]}, "updateOnlineFormActivityLogLineInput": {"properties": {"executed_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run."}, "is_visible": {"type": "boolean", "example": false, "description": "True when the line is shown in the activity log UI; false for internal-only lines."}, "online_form_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the submission."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the line within its log run."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}}}, "batchOnlineFormActivityLogLineInput": {"properties": {"executed_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run."}, "is_visible": {"type": "boolean", "example": false, "description": "True when the line is shown in the activity log UI; false for internal-only lines."}, "online_form_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the submission."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the line within its log run."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "OnlineFormDataExRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "data": {"type": "string", "format": "uri", "description": "Data record holding the additional fields linked to the online form submission.\n\nRelation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties."}, "online_form": {"type": "string", "format": "uri", "description": "Online form this data relation row belongs to.\n\nRelation to OnlineForm. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineForm' object for properties."}, "data_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the data record."}, "data_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the data set the linked fields belong to."}, "online_form_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "data", "online_form", "data_id", "data_set_id", "online_form_id"]}, "createOnlineFormDataExRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "data_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the data record."}, "data_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the data set the linked fields belong to."}, "online_form_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["data_id", "data_set_id", "online_form_id"]}, "updateOnlineFormDataExRelationInput": {"properties": {"data_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the data record."}, "data_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the data set the linked fields belong to."}, "online_form_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchOnlineFormDataExRelationInput": {"properties": {"data_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the data record."}, "data_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the data set the linked fields belong to."}, "online_form_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "OnlineFormRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account": {"type": "string", "format": "uri", "description": "Account the submission is linked to, when applicable.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "contact": {"type": "string", "format": "uri", "description": "Contact the submission is linked to, when applicable.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "custom_entity": {"type": "string", "format": "uri", "description": "Custom entity record the submission is linked to, when applicable.\n\nRelation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties."}, "lead": {"type": "string", "format": "uri", "description": "Lead the submission is linked to. Set when lead_oppty_id resolves to a Lead.\n\nRelation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties."}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity the submission is linked to. Set when lead_oppty_id resolves to an Opportunity.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "online_form": {"type": "string", "format": "uri", "description": "Online form submission being linked.\n\nRelation to OnlineForm. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineForm' object for properties."}, "project": {"type": "string", "format": "uri", "description": "Project the submission is linked to, when applicable.\n\nRelation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties."}, "quote": {"type": "string", "format": "uri", "description": "Quote the submission is linked to, when applicable.\n\nRelation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that points to the submission's primary record. There is at most one primary relation per submission and its entity must match the form's entity_type."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity, or empty when not linked."}, "online_form_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the submission."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "is_primary", "online_form_id"]}, "createOnlineFormRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that points to the submission's primary record. There is at most one primary relation per submission and its entity must match the form's entity_type."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity, or empty when not linked."}, "online_form_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the submission."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_primary", "online_form_id"]}, "updateOnlineFormRelationInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that points to the submission's primary record. There is at most one primary relation per submission and its entity must match the form's entity_type."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity, or empty when not linked."}, "online_form_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the submission."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchOnlineFormRelationInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that points to the submission's primary record. There is at most one primary relation per submission and its entity must match the form's entity_type."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity, or empty when not linked."}, "online_form_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the submission."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "OnlineFormStyle": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "object", "description": "JSON definition of the style applied to the form (colors, fonts, layout). When null, the default style is used."}, "use_lang": {"type": "boolean", "example": false, "description": "When true, the style name is treated as a translation key and localized in the UI; otherwise the literal name is shown."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "name"]}, "createOnlineFormStyleInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "object", "description": "JSON definition of the style applied to the form (colors, fonts, layout). When null, the default style is used."}, "use_lang": {"type": "boolean", "example": false, "description": "When true, the style name is treated as a translation key and localized in the UI; otherwise the literal name is shown."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["name"]}, "updateOnlineFormStyleInput": {"properties": {"name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "object", "description": "JSON definition of the style applied to the form (colors, fonts, layout). When null, the default style is used."}, "use_lang": {"type": "boolean", "example": false, "description": "When true, the style name is treated as a translation key and localized in the UI; otherwise the literal name is shown."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchOnlineFormStyleInput": {"properties": {"name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "object", "description": "JSON definition of the style applied to the form (colors, fonts, layout). When null, the default style is used."}, "use_lang": {"type": "boolean", "example": false, "description": "When true, the style name is treated as a translation key and localized in the UI; otherwise the literal name is shown."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "OnlineFormType": {"properties": {"has_draft": {"type": "boolean", "example": false, "description": "Set to True if draft for entity exists and can be published"}, "is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "form_edit_api": {"type": "object", "description": "API-friendly view of the form definition merged with any pending draft changes. Read-only; modify form_edit through drafts."}, "can_change_readonly": {"type": "boolean", "example": false, "description": "Returns if user can change readonly flag on this entity_type."}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "owner": {"type": "string", "format": "uri", "description": "User who owns the online form.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "style": {"type": "string", "format": "uri", "description": "Visual style applied to the form when rendered.\n\nRelation to OnlineFormStyle. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineFormStyle' object for properties."}, "auto_prefill_with_javascript": {"type": "boolean", "example": false, "description": "When true, the embedded form JavaScript pre-fills fields from URL query parameters on load."}, "description": {"type": "string", "example": "string", "description": "Free-text description shown alongside the form definition in the UI."}, "entity_api_name": {"type": "string", "example": "string", "description": "API name of the custom entity the form targets. Set only when entity_type is CustomEntity; otherwise empty."}, "entity_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]}, "form_edit": {"type": "object", "description": "Definition of the form layout (fields, sections, settings) shown to respondents, as a JSON object conforming to the online-form layout schema. Validated on write."}, "is_enabled": {"type": "boolean", "example": false, "description": "When true, the form is published and accepts new submissions; when false, the form returns an error to respondents."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the form is system-managed and its schema cannot be edited by users."}, "last_schema_change": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent change to form_edit (form schema)."}, "last_status_change": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent change to is_enabled."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "notifications_status": {"type": "object", "description": "Tracks which threshold-reached notifications have already been sent for the current form configuration. Reset when the configuration changes."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "style_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the form style."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "activity_logs": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to OnlineForm. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineForm' object for properties."}, "description": "Submissions (one per response) recorded for this form."}, "link_id": {"type": "string", "example": "string", "description": "Short identifier used in the public form URL (see link). Stable across the lifetime of the form."}, "summarized_response_values": {"type": "integer", "format": "int32", "example": 1, "description": "Sum of response values used to evaluate the response acceptance threshold (e.g. total responses, or evaluated value of the custom acceptance condition). Empty when no threshold is configured."}, "link": {"type": "string", "example": "string", "description": "Public URL for accessing the form (suitable for sharing with respondents)."}, "has_custom_recaptcha": {"type": "boolean", "example": false, "description": "True when the form is configured with custom reCAPTCHA credentials; false when using the platform default reCAPTCHA setup."}}, "required": ["has_draft", "is_delete_protected", "form_edit_api", "id", "owner", "style", "entity_type", "form_edit", "is_enabled", "is_readonly", "name", "owner_id", "style_id", "link_id", "has_custom_recaptcha"]}, "createOnlineFormTypeInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "auto_prefill_with_javascript": {"type": "boolean", "example": false, "description": "When true, the embedded form JavaScript pre-fills fields from URL query parameters on load."}, "description": {"type": "string", "example": "string", "description": "Free-text description shown alongside the form definition in the UI."}, "entity_api_name": {"type": "string", "example": "string", "description": "API name of the custom entity the form targets. Set only when entity_type is CustomEntity; otherwise empty."}, "entity_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]}, "form_edit": {"type": "object", "description": "Definition of the form layout (fields, sections, settings) shown to respondents, as a JSON object conforming to the online-form layout schema. Validated on write."}, "is_enabled": {"type": "boolean", "example": false, "description": "When true, the form is published and accepts new submissions; when false, the form returns an error to respondents."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the form is system-managed and its schema cannot be edited by users."}, "last_schema_change": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent change to form_edit (form schema)."}, "last_status_change": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent change to is_enabled."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "notifications_status": {"type": "object", "description": "Tracks which threshold-reached notifications have already been sent for the current form configuration. Reset when the configuration changes."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "style_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the form style."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "custom_recaptcha": {"type": "string", "format": "binary", "example": "blob", "description": ""}}, "required": ["entity_type", "form_edit", "is_enabled", "is_readonly", "name", "owner_id", "style_id", "custom_recaptcha"]}, "updateOnlineFormTypeInput": {"properties": {"auto_prefill_with_javascript": {"type": "boolean", "example": false, "description": "When true, the embedded form JavaScript pre-fills fields from URL query parameters on load."}, "description": {"type": "string", "example": "string", "description": "Free-text description shown alongside the form definition in the UI."}, "entity_api_name": {"type": "string", "example": "string", "description": "API name of the custom entity the form targets. Set only when entity_type is CustomEntity; otherwise empty."}, "entity_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]}, "form_edit": {"type": "object", "description": "Definition of the form layout (fields, sections, settings) shown to respondents, as a JSON object conforming to the online-form layout schema. Validated on write."}, "is_enabled": {"type": "boolean", "example": false, "description": "When true, the form is published and accepts new submissions; when false, the form returns an error to respondents."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the form is system-managed and its schema cannot be edited by users."}, "last_schema_change": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent change to form_edit (form schema)."}, "last_status_change": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent change to is_enabled."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "notifications_status": {"type": "object", "description": "Tracks which threshold-reached notifications have already been sent for the current form configuration. Reset when the configuration changes."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "style_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the form style."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "custom_recaptcha": {"type": "string", "format": "binary", "example": "blob", "description": ""}}}, "batchOnlineFormTypeInput": {"properties": {"auto_prefill_with_javascript": {"type": "boolean", "example": false, "description": "When true, the embedded form JavaScript pre-fills fields from URL query parameters on load."}, "description": {"type": "string", "example": "string", "description": "Free-text description shown alongside the form definition in the UI."}, "entity_api_name": {"type": "string", "example": "string", "description": "API name of the custom entity the form targets. Set only when entity_type is CustomEntity; otherwise empty."}, "entity_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]}, "form_edit": {"type": "object", "description": "Definition of the form layout (fields, sections, settings) shown to respondents, as a JSON object conforming to the online-form layout schema. Validated on write."}, "is_enabled": {"type": "boolean", "example": false, "description": "When true, the form is published and accepts new submissions; when false, the form returns an error to respondents."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the form is system-managed and its schema cannot be edited by users."}, "last_schema_change": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent change to form_edit (form schema)."}, "last_status_change": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent change to is_enabled."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "notifications_status": {"type": "object", "description": "Tracks which threshold-reached notifications have already been sent for the current form configuration. Reset when the configuration changes."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "style_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the form style."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "custom_recaptcha": {"type": "string", "format": "binary", "example": "blob", "description": ""}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "OnlineFormTypeEmailRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account": {"type": "string", "format": "uri", "description": "Account the email recipient belongs to, when applicable.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "contact": {"type": "string", "format": "uri", "description": "Contact the email was addressed to, when applicable.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "custom_entity": {"type": "string", "format": "uri", "description": "Custom entity record the form was sent on, when applicable.\n\nRelation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties."}, "email": {"type": "string", "format": "uri", "description": "Email message used to deliver the form link to the recipient.\n\nRelation to Email. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Email' object for properties."}, "lead": {"type": "string", "format": "uri", "description": "Lead the form was sent on. Set when lead_oppty_id resolves to a Lead.\n\nRelation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties."}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity the form was sent on. Set when lead_oppty_id resolves to an Opportunity.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "online_form_type": {"type": "string", "format": "uri", "description": "Online form being shared with the recipient via email.\n\nRelation to OnlineFormType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineFormType' object for properties."}, "quote": {"type": "string", "format": "uri", "description": "Quote the form was sent on, when applicable.\n\nRelation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email message."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity, or empty when not linked."}, "online_form_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "email", "online_form_type", "email_id", "online_form_type_id"]}, "createOnlineFormTypeEmailRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email message."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity, or empty when not linked."}, "online_form_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["email_id", "online_form_type_id"]}, "updateOnlineFormTypeEmailRelationInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email message."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity, or empty when not linked."}, "online_form_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchOnlineFormTypeEmailRelationInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email message."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity, or empty when not linked."}, "online_form_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Opportunity": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time."}, "active_quote": {"type": "string", "format": "uri", "description": "Quote currently used to drive the opportunity (e.g. for synchronisation of monetary fields). Empty when no quote is active.\n\nRelation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties."}, "currency_exchange_rates_list": {"type": "string", "format": "uri", "description": "Currency exchange rate list used to convert monetary fields linked to this opportunity. Empty to inherit the team space default.\n\nRelation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRatesList' object for properties."}, "lead_source": {"type": "string", "format": "uri", "description": "How the opportunity originated (e.g. Website, Referral, Trade Show). Configurable per team space.\n\nRelation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties."}, "oppty_type": {"type": "string", "format": "uri", "description": "Opportunity type that classifies this opportunity. Each type maps to one pipeline and drives which form, fields and stages apply.\n\nRelation to OpportunityType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpportunityType' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "Sales user who owns this opportunity.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "product_currency": {"type": "string", "format": "uri", "description": "Currency used for product line-item prices on this opportunity.\n\nRelation to Currency. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Currency' object for properties."}, "product_price_list": {"type": "string", "format": "uri", "description": "Product price list used to populate prices for product line items added to this opportunity. Empty to use catalog defaults.\n\nRelation to ProductPriceList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProductPriceList' object for properties."}, "reason_of_close": {"type": "string", "format": "uri", "description": "Configurable reason recorded when the opportunity is archived (lost). Required when the lost form mandates it.\n\nRelation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties."}, "step": {"type": "string", "format": "uri", "description": "Pipeline step the opportunity is currently sitting in. Reaching the last step in the pipeline marks the opportunity as won; archiving sets it to lost.\n\nRelation to Step. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Step' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit this opportunity is assigned to. Determines which team members can see the record under unit-based sharing.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "active_quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the active quote."}, "closing_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Expected or actual closing date of the opportunity."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this opportunity."}, "description": {"type": "string", "example": "string", "description": "Free-form description of the opportunity."}, "is_archived": {"type": "boolean", "example": false, "description": "True when the opportunity has been archived (lost). Archived opportunities remain readable but are hidden from active lists and cannot be edited until reactivated."}, "is_value_auto_calculate": {"type": "boolean", "example": false, "description": "True when value is auto-calculated from the opportunity product line items. False when the user enters value directly."}, "label_flag": {"type": "string", "example": 1, "enum": [1, 2, 4], "description": "User-set colored flag used to highlight the opportunity in lists and reports."}, "last_ai_buying_center_applied": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Time when an AI-suggested buying center was last applied to this opportunity."}, "lead_source_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead source."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "oppty_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity type."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity owner."}, "product_currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product currency."}, "product_price_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product price list."}, "product_sections": {"type": "object", "description": "Product sections grouping the record's line items, as a JSON array of {\"id\": <UUID>, \"name\": <string>} objects. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/productsection.doc.html"}, "quick_account_email": {"type": "string", "example": "string", "description": "Free-text company email captured at opportunity creation when no Account record has been linked yet."}, "quick_account_name": {"type": "string", "example": "string", "description": "Free-text company name captured at opportunity creation when no Account record has been linked yet."}, "quick_account_phone": {"type": "string", "example": "string", "description": "Free-text company phone captured at opportunity creation when no Account record has been linked yet."}, "quick_contact_name": {"type": "string", "example": "string", "description": "Free-text contact name captured at opportunity creation when no Contact record has been linked yet."}, "quick_email": {"type": "string", "example": "string", "description": "Free-text contact email captured at opportunity creation when no Contact record has been linked yet."}, "quick_phone": {"type": "string", "example": "string", "description": "Free-text contact phone captured at opportunity creation when no Contact record has been linked yet."}, "ranking": {"type": "integer", "format": "int32", "example": 1, "description": "Qualitative ranking score (1-10) the user assigns to indicate the strength of the opportunity."}, "reason_of_close_description": {"type": "string", "example": "string", "description": "Free-form note explaining why the opportunity was archived (lost)."}, "reason_of_close_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the reason-of-close value."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "step_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the pipeline step."}, "table_name": {"type": "string", "example": "string", "description": "Discriminator identifying the concrete record type \u2014 always \"opportunity\" for Opportunity records. Read-only; useful when consuming polymorphic LeadOppty results.", "readOnly": true}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "was_qualified": {"type": "boolean", "example": false, "description": "True when the opportunity has gone through the qualification step at least once."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "value": {"type": "object", "properties": {"base_value": {"type": "number", "format": "double", "example": "4.32", "description": "Currency."}, "currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "value_foreign": {"type": "number", "format": "double", "example": "4.32", "description": "Decimal number."}}, "required": ["base_value", "currency_id", "value_foreign"], "description": "Monetary value of the opportunity in the team space base currency, with the foreign value and currency code preserved alongside."}, "oppty_recurrence": {"type": "string", "format": "uri", "description": "Recurrence schedule generating periodic copies of this opportunity, or empty when no recurrence is set up.\n\nRelation to OpptyRecurrence. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyRecurrence' object for properties."}, "revenue_schedule": {"type": "string", "format": "uri", "description": "Revenue schedule splitting the opportunity value across periods, or empty when revenue scheduling is not enabled for this opportunity.\n\nRelation to OpptyRevenueSchedule. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyRevenueSchedule' object for properties."}, "product_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to OpptyProductRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelation' object for properties."}, "description": "Product line items on this opportunity. Each entry holds the product, quantity, price and discount that contribute to the opportunity value when is_value_auto_calculate is true."}, "primary_contact": {"type": "string", "format": "uri", "description": "Primary contact of this opportunity. Set automatically from the contact relation marked as primary.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "primary_account": {"type": "string", "format": "uri", "description": "Primary account of this opportunity. Set automatically from the account relation marked as primary.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "contact_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to LeadOpptyContactRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadOpptyContactRelation' object for properties."}, "description": "Contacts linked to this opportunity, including their roles and org-chart positions."}, "account_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to LeadOpptyAccountRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadOpptyAccountRelation' object for properties."}, "description": "Accounts linked to this opportunity, including the primary-account flag."}, "documents": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties."}, "description": "Documents linked to this opportunity."}, "quote_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties."}, "description": "Quotes prepared for this opportunity."}, "status": {"type": "integer", "description": "Current status of the opportunity (Open, Won, Lost). Read-only; derived from the current pipeline step and the archived flag.\n\nInteger enum value: 1 - Open, 2 - Lost, 3 - Won", "example": 1, "enum": [1, 2, 3], "readOnly": true}, "qualify_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of when the opportunity was qualified, taken from the matching KPI event. Empty for opportunities that have not been qualified. Read-only."}, "won_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of when the opportunity was won. Setting it adjusts the underlying win event; empty for opportunities that have not been won."}, "lost_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of when the opportunity was archived (lost). Setting it adjusts the underlying loss event; empty for opportunities that have not been archived."}, "days_in_step": {"type": "integer", "format": "int32", "example": 1, "description": "Number of days the opportunity has been sitting in its current pipeline step. Read-only; computed by Coevera from the most recent move event and per-step timeframe history."}, "is_favorite": {"type": "boolean", "example": false, "description": "True when the current authenticated user has marked this opportunity as favorite. Per-user."}, "sharing_units": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to LeadOpptySharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadOpptySharingSalesUnitRelation' object for properties."}, "description": "Sales units that have been granted shared access to this opportunity. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to LeadOpptySharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadOpptySharingClientRelation' object for properties."}, "description": "Users that have been granted shared access to this opportunity. Editable only when share_mode allows user sharing."}, "tags": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to TagRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TagRelation' object for properties."}, "description": "Tag labels applied to this opportunity."}, "static_profiles": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ProfileRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProfileRelation' object for properties."}, "description": "Saved view profiles this opportunity currently matches."}, "formatted_name": {"type": "string", "example": "string", "description": "Display version of the opportunity name, used in lists and references."}, "modified_by_user": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera."}}, "required": ["is_delete_protected", "id", "oppty_type", "owner", "product_currency", "step", "unit", "closing_date", "name", "owner_id", "step_id", "table_name", "value", "status", "days_in_step", "is_favorite", "formatted_name"]}, "createOpportunityInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time."}, "active_quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the active quote."}, "closing_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Expected or actual closing date of the opportunity."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this opportunity."}, "description": {"type": "string", "example": "string", "description": "Free-form description of the opportunity."}, "is_archived": {"type": "boolean", "example": false, "description": "True when the opportunity has been archived (lost). Archived opportunities remain readable but are hidden from active lists and cannot be edited until reactivated."}, "is_value_auto_calculate": {"type": "boolean", "example": false, "description": "True when value is auto-calculated from the opportunity product line items. False when the user enters value directly."}, "label_flag": {"type": "string", "example": 1, "enum": [1, 2, 4], "description": "User-set colored flag used to highlight the opportunity in lists and reports."}, "last_ai_buying_center_applied": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Time when an AI-suggested buying center was last applied to this opportunity."}, "lead_source_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead source."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "oppty_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity type."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity owner."}, "product_currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product currency."}, "product_price_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product price list."}, "product_sections": {"type": "object", "description": "Product sections grouping the record's line items, as a JSON array of {\"id\": <UUID>, \"name\": <string>} objects. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/productsection.doc.html"}, "quick_account_email": {"type": "string", "example": "string", "description": "Free-text company email captured at opportunity creation when no Account record has been linked yet."}, "quick_account_name": {"type": "string", "example": "string", "description": "Free-text company name captured at opportunity creation when no Account record has been linked yet."}, "quick_account_phone": {"type": "string", "example": "string", "description": "Free-text company phone captured at opportunity creation when no Account record has been linked yet."}, "quick_contact_name": {"type": "string", "example": "string", "description": "Free-text contact name captured at opportunity creation when no Contact record has been linked yet."}, "quick_email": {"type": "string", "example": "string", "description": "Free-text contact email captured at opportunity creation when no Contact record has been linked yet."}, "quick_phone": {"type": "string", "example": "string", "description": "Free-text contact phone captured at opportunity creation when no Contact record has been linked yet."}, "ranking": {"type": "integer", "format": "int32", "example": 1, "description": "Qualitative ranking score (1-10) the user assigns to indicate the strength of the opportunity."}, "reason_of_close_description": {"type": "string", "example": "string", "description": "Free-form note explaining why the opportunity was archived (lost)."}, "reason_of_close_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the reason-of-close value."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "step_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the pipeline step."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "was_qualified": {"type": "boolean", "example": false, "description": "True when the opportunity has gone through the qualification step at least once."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "value": {"type": "object", "properties": {"base_value": {"type": "number", "format": "double", "example": "4.32", "description": "Currency."}, "currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "value_foreign": {"type": "number", "format": "double", "example": "4.32", "description": "Decimal number."}}, "required": ["base_value", "currency_id", "value_foreign"], "description": "Monetary value of the opportunity in the team space base currency, with the foreign value and currency code preserved alongside."}, "oppty_recurrence": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Recurrence schedule generating periodic copies of this opportunity, or empty when no recurrence is set up.\n\nRelation to OpptyRecurrence, see: 'createOpptyRecurrenceInput' object for properties."}, "revenue_schedule": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Revenue schedule splitting the opportunity value across periods, or empty when revenue scheduling is not enabled for this opportunity.\n\nRelation to OpptyRevenueSchedule, see: 'createOpptyRevenueScheduleInput' object for properties."}, "product_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OpptyProductRelation, see: 'createOpptyProductRelationInput' object for properties."}, "description": "Product line items on this opportunity. Each entry holds the product, quantity, price and discount that contribute to the opportunity value when is_value_auto_calculate is true."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptyContactRelation, see: 'createLeadOpptyContactRelationInput' object for properties."}, "description": "Contacts linked to this opportunity, including their roles and org-chart positions."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptyAccountRelation, see: 'createLeadOpptyAccountRelationInput' object for properties."}, "description": "Accounts linked to this opportunity, including the primary-account flag."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this opportunity."}, "quote_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to Quote, see: 'createQuoteInput' object for properties."}, "description": "Quotes prepared for this opportunity."}, "won_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of when the opportunity was won. Setting it adjusts the underlying win event; empty for opportunities that have not been won."}, "lost_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of when the opportunity was archived (lost). Setting it adjusts the underlying loss event; empty for opportunities that have not been archived."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptySharingSalesUnitRelation, see: 'createLeadOpptySharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this opportunity. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptySharingClientRelation, see: 'createLeadOpptySharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this opportunity. Editable only when share_mode allows user sharing."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'createTagRelationInput' object for properties."}, "description": "Tag labels applied to this opportunity."}, "static_profiles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProfileRelation, see: 'createProfileRelationInput' object for properties."}, "description": "Saved view profiles this opportunity currently matches."}}, "required": ["closing_date", "name", "owner_id", "step_id", "value"]}, "updateOpportunityInput": {"properties": {"created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time."}, "active_quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the active quote."}, "closing_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Expected or actual closing date of the opportunity."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this opportunity."}, "description": {"type": "string", "example": "string", "description": "Free-form description of the opportunity."}, "is_archived": {"type": "boolean", "example": false, "description": "True when the opportunity has been archived (lost). Archived opportunities remain readable but are hidden from active lists and cannot be edited until reactivated."}, "is_value_auto_calculate": {"type": "boolean", "example": false, "description": "True when value is auto-calculated from the opportunity product line items. False when the user enters value directly."}, "label_flag": {"type": "string", "example": 1, "enum": [1, 2, 4], "description": "User-set colored flag used to highlight the opportunity in lists and reports."}, "last_ai_buying_center_applied": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Time when an AI-suggested buying center was last applied to this opportunity."}, "lead_source_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead source."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "oppty_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity type."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity owner."}, "product_currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product currency."}, "product_price_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product price list."}, "product_sections": {"type": "object", "description": "Product sections grouping the record's line items, as a JSON array of {\"id\": <UUID>, \"name\": <string>} objects. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/productsection.doc.html"}, "quick_account_email": {"type": "string", "example": "string", "description": "Free-text company email captured at opportunity creation when no Account record has been linked yet."}, "quick_account_name": {"type": "string", "example": "string", "description": "Free-text company name captured at opportunity creation when no Account record has been linked yet."}, "quick_account_phone": {"type": "string", "example": "string", "description": "Free-text company phone captured at opportunity creation when no Account record has been linked yet."}, "quick_contact_name": {"type": "string", "example": "string", "description": "Free-text contact name captured at opportunity creation when no Contact record has been linked yet."}, "quick_email": {"type": "string", "example": "string", "description": "Free-text contact email captured at opportunity creation when no Contact record has been linked yet."}, "quick_phone": {"type": "string", "example": "string", "description": "Free-text contact phone captured at opportunity creation when no Contact record has been linked yet."}, "ranking": {"type": "integer", "format": "int32", "example": 1, "description": "Qualitative ranking score (1-10) the user assigns to indicate the strength of the opportunity."}, "reason_of_close_description": {"type": "string", "example": "string", "description": "Free-form note explaining why the opportunity was archived (lost)."}, "reason_of_close_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the reason-of-close value."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "step_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the pipeline step."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "was_qualified": {"type": "boolean", "example": false, "description": "True when the opportunity has gone through the qualification step at least once."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "value": {"type": "object", "properties": {"base_value": {"type": "number", "format": "double", "example": "4.32", "description": "Currency."}, "currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "value_foreign": {"type": "number", "format": "double", "example": "4.32", "description": "Decimal number."}}, "required": ["base_value", "currency_id", "value_foreign"], "description": "Monetary value of the opportunity in the team space base currency, with the foreign value and currency code preserved alongside."}, "oppty_recurrence": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Recurrence schedule generating periodic copies of this opportunity, or empty when no recurrence is set up.\n\nRelation to OpptyRecurrence, see: 'updateOpptyRecurrenceInput' object for properties."}, "revenue_schedule": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Revenue schedule splitting the opportunity value across periods, or empty when revenue scheduling is not enabled for this opportunity.\n\nRelation to OpptyRevenueSchedule, see: 'updateOpptyRevenueScheduleInput' object for properties."}, "product_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OpptyProductRelation, see: 'updateOpptyProductRelationInput' object for properties."}, "description": "Product line items on this opportunity. Each entry holds the product, quantity, price and discount that contribute to the opportunity value when is_value_auto_calculate is true."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptyContactRelation, see: 'updateLeadOpptyContactRelationInput' object for properties."}, "description": "Contacts linked to this opportunity, including their roles and org-chart positions."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptyAccountRelation, see: 'updateLeadOpptyAccountRelationInput' object for properties."}, "description": "Accounts linked to this opportunity, including the primary-account flag."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this opportunity."}, "quote_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to Quote, see: 'updateQuoteInput' object for properties."}, "description": "Quotes prepared for this opportunity."}, "won_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of when the opportunity was won. Setting it adjusts the underlying win event; empty for opportunities that have not been won."}, "lost_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of when the opportunity was archived (lost). Setting it adjusts the underlying loss event; empty for opportunities that have not been archived."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptySharingSalesUnitRelation, see: 'updateLeadOpptySharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this opportunity. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptySharingClientRelation, see: 'updateLeadOpptySharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this opportunity. Editable only when share_mode allows user sharing."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'updateTagRelationInput' object for properties."}, "description": "Tag labels applied to this opportunity."}, "static_profiles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProfileRelation, see: 'updateProfileRelationInput' object for properties."}, "description": "Saved view profiles this opportunity currently matches."}}}, "batchOpportunityInput": {"properties": {"created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time."}, "active_quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the active quote."}, "closing_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Expected or actual closing date of the opportunity."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this opportunity."}, "description": {"type": "string", "example": "string", "description": "Free-form description of the opportunity."}, "is_archived": {"type": "boolean", "example": false, "description": "True when the opportunity has been archived (lost). Archived opportunities remain readable but are hidden from active lists and cannot be edited until reactivated."}, "is_value_auto_calculate": {"type": "boolean", "example": false, "description": "True when value is auto-calculated from the opportunity product line items. False when the user enters value directly."}, "label_flag": {"type": "string", "example": 1, "enum": [1, 2, 4], "description": "User-set colored flag used to highlight the opportunity in lists and reports."}, "last_ai_buying_center_applied": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Time when an AI-suggested buying center was last applied to this opportunity."}, "lead_source_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead source."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "oppty_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity type."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity owner."}, "product_currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product currency."}, "product_price_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product price list."}, "product_sections": {"type": "object", "description": "Product sections grouping the record's line items, as a JSON array of {\"id\": <UUID>, \"name\": <string>} objects. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/productsection.doc.html"}, "quick_account_email": {"type": "string", "example": "string", "description": "Free-text company email captured at opportunity creation when no Account record has been linked yet."}, "quick_account_name": {"type": "string", "example": "string", "description": "Free-text company name captured at opportunity creation when no Account record has been linked yet."}, "quick_account_phone": {"type": "string", "example": "string", "description": "Free-text company phone captured at opportunity creation when no Account record has been linked yet."}, "quick_contact_name": {"type": "string", "example": "string", "description": "Free-text contact name captured at opportunity creation when no Contact record has been linked yet."}, "quick_email": {"type": "string", "example": "string", "description": "Free-text contact email captured at opportunity creation when no Contact record has been linked yet."}, "quick_phone": {"type": "string", "example": "string", "description": "Free-text contact phone captured at opportunity creation when no Contact record has been linked yet."}, "ranking": {"type": "integer", "format": "int32", "example": 1, "description": "Qualitative ranking score (1-10) the user assigns to indicate the strength of the opportunity."}, "reason_of_close_description": {"type": "string", "example": "string", "description": "Free-form note explaining why the opportunity was archived (lost)."}, "reason_of_close_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the reason-of-close value."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "step_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the pipeline step."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "was_qualified": {"type": "boolean", "example": false, "description": "True when the opportunity has gone through the qualification step at least once."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "value": {"type": "object", "properties": {"base_value": {"type": "number", "format": "double", "example": "4.32", "description": "Currency."}, "currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "value_foreign": {"type": "number", "format": "double", "example": "4.32", "description": "Decimal number."}}, "required": ["base_value", "currency_id", "value_foreign"], "description": "Monetary value of the opportunity in the team space base currency, with the foreign value and currency code preserved alongside."}, "oppty_recurrence": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Recurrence schedule generating periodic copies of this opportunity, or empty when no recurrence is set up.\n\nRelation to OpptyRecurrence, see: 'updateOpptyRecurrenceInput' object for properties."}, "revenue_schedule": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Revenue schedule splitting the opportunity value across periods, or empty when revenue scheduling is not enabled for this opportunity.\n\nRelation to OpptyRevenueSchedule, see: 'updateOpptyRevenueScheduleInput' object for properties."}, "product_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OpptyProductRelation, see: 'updateOpptyProductRelationInput' object for properties."}, "description": "Product line items on this opportunity. Each entry holds the product, quantity, price and discount that contribute to the opportunity value when is_value_auto_calculate is true."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptyContactRelation, see: 'updateLeadOpptyContactRelationInput' object for properties."}, "description": "Contacts linked to this opportunity, including their roles and org-chart positions."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptyAccountRelation, see: 'updateLeadOpptyAccountRelationInput' object for properties."}, "description": "Accounts linked to this opportunity, including the primary-account flag."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this opportunity."}, "quote_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to Quote, see: 'updateQuoteInput' object for properties."}, "description": "Quotes prepared for this opportunity."}, "won_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of when the opportunity was won. Setting it adjusts the underlying win event; empty for opportunities that have not been won."}, "lost_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of when the opportunity was archived (lost). Setting it adjusts the underlying loss event; empty for opportunities that have not been archived."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptySharingSalesUnitRelation, see: 'updateLeadOpptySharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this opportunity. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to LeadOpptySharingClientRelation, see: 'updateLeadOpptySharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this opportunity. Editable only when share_mode allows user sharing."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'updateTagRelationInput' object for properties."}, "description": "Tag labels applied to this opportunity."}, "static_profiles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProfileRelation, see: 'updateProfileRelationInput' object for properties."}, "description": "Saved view profiles this opportunity currently matches."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "OpportunityType": {"properties": {"id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "pipeline": {"type": "string", "format": "uri", "description": "Pipeline this opportunity type drives. Each opportunity type maps to exactly one pipeline.\n\nRelation to Pipeline. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Pipeline' object for properties."}, "form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing opportunities of this type."}, "form_lost": {"type": "object", "description": "JSON definition of the form shown when archiving (losing) an opportunity of this type. Used to capture reason of close and any required closing fields."}, "form_qualify": {"type": "object", "description": "JSON definition of the form shown when qualifying a lead into an opportunity of this type."}, "form_won": {"type": "object", "description": "JSON definition of the form shown when winning an opportunity of this type. Used to capture won-deal fields."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the opportunity type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "pipeline_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the pipeline."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "is_published": {"type": "boolean", "example": false, "description": "True when the entity configuration is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "has_draft": {"type": "boolean", "example": false, "description": "Set to True if draft for entity exists and can be published"}, "is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "form_edit_api": {"type": "object", "description": "API-friendly form definition. Returns the published form merged with any pending draft changes; read via this field, modify via the underlying form_edit / form_lost field through drafts."}, "can_change_readonly": {"type": "boolean", "example": false, "description": "Returns if user can change readonly flag on this entity_type."}, "form_lost_api": {"type": "object", "description": "API-friendly form definition. Returns the published form merged with any pending draft changes; read via this field, modify via the underlying form_edit / form_lost field through drafts."}, "form_qualify_api": {"type": "array", "items": {"type": "object"}, "description": "List of field ids selected on a derived form (qualify or won transition). Read-only; modify the underlying form_qualify / form_won field through drafts."}, "form_won_api": {"type": "array", "items": {"type": "object"}, "description": "List of field ids selected on a derived form (qualify or won transition). Read-only; modify the underlying form_qualify / form_won field through drafts."}}, "required": ["id", "pipeline", "is_readonly", "name", "pipeline_id", "settings", "has_draft", "is_delete_protected", "form_edit_api", "form_lost_api", "form_qualify_api", "form_won_api"]}, "createOpportunityTypeInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing opportunities of this type."}, "form_lost": {"type": "object", "description": "JSON definition of the form shown when archiving (losing) an opportunity of this type. Used to capture reason of close and any required closing fields."}, "form_qualify": {"type": "object", "description": "JSON definition of the form shown when qualifying a lead into an opportunity of this type."}, "form_won": {"type": "object", "description": "JSON definition of the form shown when winning an opportunity of this type. Used to capture won-deal fields."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the opportunity type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "pipeline_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the pipeline."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "is_published": {"type": "boolean", "example": false, "description": "True when the entity configuration is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_readonly", "name", "pipeline_id", "settings"]}, "updateOpportunityTypeInput": {"properties": {"form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing opportunities of this type."}, "form_lost": {"type": "object", "description": "JSON definition of the form shown when archiving (losing) an opportunity of this type. Used to capture reason of close and any required closing fields."}, "form_qualify": {"type": "object", "description": "JSON definition of the form shown when qualifying a lead into an opportunity of this type."}, "form_won": {"type": "object", "description": "JSON definition of the form shown when winning an opportunity of this type. Used to capture won-deal fields."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the opportunity type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "pipeline_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the pipeline."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchOpportunityTypeInput": {"properties": {"form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing opportunities of this type."}, "form_lost": {"type": "object", "description": "JSON definition of the form shown when archiving (losing) an opportunity of this type. Used to capture reason of close and any required closing fields."}, "form_qualify": {"type": "object", "description": "JSON definition of the form shown when qualifying a lead into an opportunity of this type."}, "form_won": {"type": "object", "description": "JSON definition of the form shown when winning an opportunity of this type. Used to capture won-deal fields."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the opportunity type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "pipeline_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the pipeline."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "OpptyProductRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "currency_exchange_rates_list": {"type": "string", "format": "uri", "description": "Currency exchange rate list used to convert this line item, inherited from the parent opportunity or quote.\n\nRelation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRatesList' object for properties."}, "online_form_field": {"type": "string", "format": "uri", "description": "Online form field that produced this line item, or empty when not applicable.\n\nRelation to Field. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Field' object for properties."}, "online_form": {"type": "string", "format": "uri", "description": "Online form this line item came from when the related opportunity was created through a form submission, or empty otherwise.\n\nRelation to OnlineForm. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineForm' object for properties."}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity this line item belongs to. Set on create; mutually exclusive with quote.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties.", "readOnly": true}, "oppty_product_relation_type": {"type": "string", "format": "uri", "description": "Line-item type that drives the form layout for this product line. Resolved from the product type on create.\n\nRelation to OpptyProductRelationType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelationType' object for properties."}, "paired_oppty_product_relation": {"type": "string", "format": "uri", "description": "Counterpart line item on the paired record (e.g. matching line on the active quote when this line is on the opportunity, or vice versa). Empty when there is no pairing.\n\nRelation to OpptyProductRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelation' object for properties."}, "product": {"type": "string", "format": "uri", "description": "Product on this line item. Set on create; cannot be changed afterwards.\n\nRelation to Product. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Product' object for properties.", "readOnly": true}, "quote": {"type": "string", "format": "uri", "description": "Quote this line item belongs to. Mutually exclusive with oppty.\n\nRelation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties."}, "amount": {"type": "number", "format": "double", "example": "4.32", "description": "Total amount of the line item (price * quantity, with discounts applied)."}, "comment": {"type": "string", "example": "string", "description": "Free-form note describing this line item."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list."}, "online_form_field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form field."}, "online_form_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form."}, "oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity."}, "oppty_product_relation_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the line-item type."}, "paired_oppty_product_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the paired line item."}, "price": {"type": "number", "format": "double", "example": "4.32", "description": "Per-unit price of the line item. Defaults to the product price from the price list when not supplied explicitly."}, "product_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product.", "readOnly": true}, "quantity": {"type": "number", "format": "double", "example": "4.32", "description": "Number of product units on this line item."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "section_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier of the product section this line belongs to (see the product_sections JSON layout on the parent opportunity or quote)."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Display order of the line item within its section. Maintained automatically when lines are added or moved."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "revenue_schedule": {"type": "string", "format": "uri", "description": "Per-line revenue schedule splitting the line amount across periods. Available only when revenue scheduling is configured at product-amount level.\n\nRelation to OpptyProductRelationRevenueSchedule. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelationRevenueSchedule' object for properties."}, "discount_value": {"type": "number", "format": "double", "example": 4.32, "description": "Absolute monetary discount applied to this line item versus the price-list price. Read-only; computed by Coevera."}, "discount_percentage": {"type": "number", "format": "double", "example": 4.32, "description": "Percentage discount applied to this line item versus the price-list price. Read-only; computed by Coevera."}, "modified_by_user": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera."}}, "required": ["is_delete_protected", "id", "oppty_product_relation_type", "product", "product_id"]}, "createOpptyProductRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "paired_oppty_product_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Counterpart line item on the paired record (e.g. matching line on the active quote when this line is on the opportunity, or vice versa). Empty when there is no pairing.\n\nRelation to OpptyProductRelation, see: 'createOpptyProductRelationInput' object for properties."}, "amount": {"type": "number", "format": "double", "example": "4.32", "description": "Total amount of the line item (price * quantity, with discounts applied)."}, "comment": {"type": "string", "example": "string", "description": "Free-form note describing this line item."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list."}, "online_form_field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form field."}, "online_form_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form."}, "oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity."}, "oppty_product_relation_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the line-item type."}, "paired_oppty_product_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the paired line item."}, "price": {"type": "number", "format": "double", "example": "4.32", "description": "Per-unit price of the line item. Defaults to the product price from the price list when not supplied explicitly."}, "product_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product.", "readOnly": true}, "quantity": {"type": "number", "format": "double", "example": "4.32", "description": "Number of product units on this line item."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "section_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier of the product section this line belongs to (see the product_sections JSON layout on the parent opportunity or quote)."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Display order of the line item within its section. Maintained automatically when lines are added or moved."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "revenue_schedule": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Per-line revenue schedule splitting the line amount across periods. Available only when revenue scheduling is configured at product-amount level.\n\nRelation to OpptyProductRelationRevenueSchedule, see: 'createOpptyProductRelationRevenueScheduleInput' object for properties."}}, "required": ["product_id"]}, "updateOpptyProductRelationInput": {"properties": {"paired_oppty_product_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Counterpart line item on the paired record (e.g. matching line on the active quote when this line is on the opportunity, or vice versa). Empty when there is no pairing.\n\nRelation to OpptyProductRelation, see: 'updateOpptyProductRelationInput' object for properties."}, "amount": {"type": "number", "format": "double", "example": "4.32", "description": "Total amount of the line item (price * quantity, with discounts applied)."}, "comment": {"type": "string", "example": "string", "description": "Free-form note describing this line item."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list."}, "online_form_field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form field."}, "online_form_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form."}, "oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity."}, "oppty_product_relation_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the line-item type."}, "paired_oppty_product_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the paired line item."}, "price": {"type": "number", "format": "double", "example": "4.32", "description": "Per-unit price of the line item. Defaults to the product price from the price list when not supplied explicitly."}, "quantity": {"type": "number", "format": "double", "example": "4.32", "description": "Number of product units on this line item."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "section_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier of the product section this line belongs to (see the product_sections JSON layout on the parent opportunity or quote)."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Display order of the line item within its section. Maintained automatically when lines are added or moved."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "revenue_schedule": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Per-line revenue schedule splitting the line amount across periods. Available only when revenue scheduling is configured at product-amount level.\n\nRelation to OpptyProductRelationRevenueSchedule, see: 'updateOpptyProductRelationRevenueScheduleInput' object for properties."}}}, "batchOpptyProductRelationInput": {"properties": {"paired_oppty_product_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Counterpart line item on the paired record (e.g. matching line on the active quote when this line is on the opportunity, or vice versa). Empty when there is no pairing.\n\nRelation to OpptyProductRelation, see: 'updateOpptyProductRelationInput' object for properties."}, "amount": {"type": "number", "format": "double", "example": "4.32", "description": "Total amount of the line item (price * quantity, with discounts applied)."}, "comment": {"type": "string", "example": "string", "description": "Free-form note describing this line item."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list."}, "online_form_field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form field."}, "online_form_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the online form."}, "oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity."}, "oppty_product_relation_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the line-item type."}, "paired_oppty_product_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the paired line item."}, "price": {"type": "number", "format": "double", "example": "4.32", "description": "Per-unit price of the line item. Defaults to the product price from the price list when not supplied explicitly."}, "quantity": {"type": "number", "format": "double", "example": "4.32", "description": "Number of product units on this line item."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "section_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier of the product section this line belongs to (see the product_sections JSON layout on the parent opportunity or quote)."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Display order of the line item within its section. Maintained automatically when lines are added or moved."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "revenue_schedule": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Per-line revenue schedule splitting the line amount across periods. Available only when revenue scheduling is configured at product-amount level.\n\nRelation to OpptyProductRelationRevenueSchedule, see: 'updateOpptyProductRelationRevenueScheduleInput' object for properties."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "OpptyProductRelationDataExRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "data": {"type": "string", "format": "uri", "description": "External data record (Data entity) holding the enrichment payload.\n\nRelation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties."}, "oppty_product_relation": {"type": "string", "format": "uri", "description": "Product line item this enrichment record applies to.\n\nRelation to OpptyProductRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelation' object for properties."}, "data_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the external data record."}, "data_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier of the data set the enrichment record originates from."}, "oppty_product_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product line item."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "data", "oppty_product_relation", "data_id", "data_set_id", "oppty_product_relation_id"]}, "createOpptyProductRelationDataExRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "oppty_product_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Product line item this enrichment record applies to.\n\nRelation to OpptyProductRelation, see: 'createOpptyProductRelationInput' object for properties."}, "data_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the external data record."}, "data_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier of the data set the enrichment record originates from."}, "oppty_product_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product line item."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["oppty_product_relation", "data_id", "data_set_id", "oppty_product_relation_id"]}, "updateOpptyProductRelationDataExRelationInput": {"properties": {"oppty_product_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Product line item this enrichment record applies to.\n\nRelation to OpptyProductRelation, see: 'updateOpptyProductRelationInput' object for properties."}, "data_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the external data record."}, "data_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier of the data set the enrichment record originates from."}, "oppty_product_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product line item."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchOpptyProductRelationDataExRelationInput": {"properties": {"oppty_product_relation": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Product line item this enrichment record applies to.\n\nRelation to OpptyProductRelation, see: 'updateOpptyProductRelationInput' object for properties."}, "data_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the external data record."}, "data_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier of the data set the enrichment record originates from."}, "oppty_product_relation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product line item."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "OpptyProductRelationRevenueSchedule": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity. Must match with OpptyProductRelation id.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted."}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "cancelation_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when the revenue schedule was cancelled. Empty for active schedules."}, "period_count": {"type": "integer", "format": "int32", "example": 1, "description": "Number of periods the line-item amount is split into."}, "period_type": {"type": "integer", "description": "Length of each period (e.g. Monthly, Quarterly, Yearly).\n\nInteger enum value: 1 - Month, 2 - Quarter, 3 - Year", "example": 1, "enum": [1, 2, 3]}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when revenue recognition for this product line begins."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "periods": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to OpptyProductRelationRevenueSchedulePeriod. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelationRevenueSchedulePeriod' object for properties."}, "description": "Periods produced by this revenue schedule, ordered by date."}}, "required": ["is_delete_protected", "id"]}, "createOpptyProductRelationRevenueScheduleInput": {"properties": {"id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity. Must match with OpptyProductRelation id.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted."}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "cancelation_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when the revenue schedule was cancelled. Empty for active schedules."}, "period_count": {"type": "integer", "format": "int32", "example": 1, "description": "Number of periods the line-item amount is split into."}, "period_type": {"type": "integer", "description": "Length of each period (e.g. Monthly, Quarterly, Yearly).\n\nInteger enum value: 1 - Month, 2 - Quarter, 3 - Year", "example": 1, "enum": [1, 2, 3]}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when revenue recognition for this product line begins."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["id"]}, "updateOpptyProductRelationRevenueScheduleInput": {"properties": {"is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted."}, "cancelation_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when the revenue schedule was cancelled. Empty for active schedules."}, "period_count": {"type": "integer", "format": "int32", "example": 1, "description": "Number of periods the line-item amount is split into."}, "period_type": {"type": "integer", "description": "Length of each period (e.g. Monthly, Quarterly, Yearly).\n\nInteger enum value: 1 - Month, 2 - Quarter, 3 - Year", "example": 1, "enum": [1, 2, 3]}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when revenue recognition for this product line begins."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchOpptyProductRelationRevenueScheduleInput": {"properties": {"is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted."}, "cancelation_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when the revenue schedule was cancelled. Empty for active schedules."}, "period_count": {"type": "integer", "format": "int32", "example": 1, "description": "Number of periods the line-item amount is split into."}, "period_type": {"type": "integer", "description": "Length of each period (e.g. Monthly, Quarterly, Yearly).\n\nInteger enum value: 1 - Month, 2 - Quarter, 3 - Year", "example": 1, "enum": [1, 2, 3]}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when revenue recognition for this product line begins."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "OpptyProductRelationRevenueSchedulePeriod": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "oppty_product_relation_revenue_schedule": {"type": "string", "format": "uri", "description": "Parent revenue schedule this period belongs to.\n\nRelation to OpptyProductRelationRevenueSchedule. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelationRevenueSchedule' object for properties."}, "date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Recognition date of this period."}, "oppty_product_relation_revenue_schedule_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent revenue schedule."}, "transaction_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier linking the period to the recognition transaction."}, "value": {"type": "number", "format": "double", "example": 4.32, "description": "Amount recognised in this period."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "oppty_product_relation_revenue_schedule", "oppty_product_relation_revenue_schedule_id", "transaction_id"]}, "createOpptyProductRelationRevenueSchedulePeriodInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "oppty_product_relation_revenue_schedule": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Parent revenue schedule this period belongs to.\n\nRelation to OpptyProductRelationRevenueSchedule, see: 'createOpptyProductRelationRevenueScheduleInput' object for properties."}, "date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Recognition date of this period."}, "oppty_product_relation_revenue_schedule_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent revenue schedule."}, "transaction_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier linking the period to the recognition transaction."}, "value": {"type": "number", "format": "double", "example": 4.32, "description": "Amount recognised in this period."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["oppty_product_relation_revenue_schedule", "oppty_product_relation_revenue_schedule_id", "transaction_id"]}, "updateOpptyProductRelationRevenueSchedulePeriodInput": {"properties": {"oppty_product_relation_revenue_schedule": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Parent revenue schedule this period belongs to.\n\nRelation to OpptyProductRelationRevenueSchedule, see: 'updateOpptyProductRelationRevenueScheduleInput' object for properties."}, "date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Recognition date of this period."}, "oppty_product_relation_revenue_schedule_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent revenue schedule."}, "transaction_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier linking the period to the recognition transaction."}, "value": {"type": "number", "format": "double", "example": 4.32, "description": "Amount recognised in this period."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchOpptyProductRelationRevenueSchedulePeriodInput": {"properties": {"oppty_product_relation_revenue_schedule": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Parent revenue schedule this period belongs to.\n\nRelation to OpptyProductRelationRevenueSchedule, see: 'updateOpptyProductRelationRevenueScheduleInput' object for properties."}, "date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Recognition date of this period."}, "oppty_product_relation_revenue_schedule_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent revenue schedule."}, "transaction_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier linking the period to the recognition transaction."}, "value": {"type": "number", "format": "double", "example": 4.32, "description": "Amount recognised in this period."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "OpptyProductRelationType": {"properties": {"has_draft": {"type": "boolean", "example": false, "description": "Set to True if draft for entity exists and can be published"}, "is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "form_edit_api": {"type": "object", "description": "API-friendly form definition. Returns the published form merged with any pending draft changes; read via this field, modify via the underlying form_edit / form_lost field through drafts."}, "can_change_readonly": {"type": "boolean", "example": false, "description": "Returns if user can change readonly flag on this entity_type."}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when adding line items of this type to opportunities or quotes."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the line-item type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "is_published": {"type": "boolean", "example": false, "description": "True when the entity configuration is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "product_type": {"type": "string", "format": "uri", "description": "Product type paired with this line-item type.\n\nRelation to ProductType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProductType' object for properties."}, "product_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the paired product type. Read-only."}}, "required": ["has_draft", "is_delete_protected", "form_edit_api", "id", "is_readonly", "name", "product_type", "product_type_id"]}, "createOpptyProductRelationTypeInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when adding line items of this type to opportunities or quotes."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the line-item type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "is_published": {"type": "boolean", "example": false, "description": "True when the entity configuration is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_readonly", "name"]}, "updateOpptyProductRelationTypeInput": {"properties": {"form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when adding line items of this type to opportunities or quotes."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the line-item type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchOpptyProductRelationTypeInput": {"properties": {"form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when adding line items of this type to opportunities or quotes."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the line-item type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "OpptyRecurrence": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity this recurrence belongs to. Each recurrence is bound to exactly one opportunity.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "step": {"type": "string", "format": "uri", "description": "Pipeline step that newly generated opportunities are placed in.\n\nRelation to Step. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Step' object for properties."}, "condition": {"type": "string", "example": 1, "enum": [1, 2], "description": "Bit Flag field, with limited combination of integer values.\n    \nOptions:\nWon = 1 (0b01)\nLost = 2 (0b10) It is required if the recurrence is set. Conditionally generated opportunity as bitwise operation where bit: 1 bit - won 2 bit - loste.g. if the value is 1 => to generate only when opportunity is won."}, "day": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative.\n\nInteger enum value: 1 - Day1, 2 - Day2, 3 - Day3, 4 - Day4, 5 - Day5, 6 - Day6, 7 - Day7, 8 - Day8, 9 - Day9, 10 - Day10, 11 - Day11, 12 - Day12, 13 - Day13, 14 - Day14, 15 - Day15, 16 - Day16, 17 - Day17, 18 - Day18, 19 - Day19, 20 - Day20, 21 - Day21, 22 - Day22, 23 - Day23, 24 - Day24, 25 - Day25, 26 - Day26, 27 - Day27, 28 - Day28, 29 - Day29, 30 - Day30, 31 - Day31", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31]}, "day_of_week": {"type": "string", "example": 1, "enum": [1, 2, 4, 8, 16, 32, 64], "description": "Bit Flag field, with limited combination of integer values.\n    \nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute."}, "end_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date information. The last date when no more other items should be created."}, "month": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only     for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative.\n\nInteger enum value: 1 - Month1, 2 - Month2, 3 - Month3, 4 - Month4, 5 - Month5, 6 - Month6, 7 - Month7, 8 - Month8, 9 - Month9, 10 - Month10, 11 - Month11, 12 - Month12", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]}, "occur_every": {"type": "integer", "format": "int32", "example": 1, "description": "Generic field wrapping sqlalchemy column, configurable by constructor.\n    Good for one-of fields / generated fields.\n     The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum."}, "occurrences_count": {"type": "integer", "format": "int32", "example": 1, "description": "Whole natural number. The number of remaining occurrences. Each time a new     one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0,     recurrence is stopped. If -1, no limits are applied."}, "oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent opportunity."}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date information. The effective start date of recurrence, which means each     next recurrence must be on or after this date."}, "step_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance. Step related to recurrence. A new opportunity will create     to this step."}, "type": {"type": "integer", "description": "Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative).\n\nInteger enum value: 0 - NotSet, 1 - Daily, 2 - Weekly, 3 - MonthlyRelative, 4 - MonthlyAbsolute, 5 - YearlyRelative, 6 - YearlyAbsolute, 7 - AfterNDays, 8 - AfterNWeeks, 9 - AfterNMonths, 10 - AfterNYears", "example": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]}, "week": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only     for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute.\n\nInteger enum value: -1 - WeekLast, 1 - Week1, 2 - Week2, 3 - Week3, 4 - Week4", "example": -1, "enum": [-1, 1, 2, 3, 4]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "oppty", "oppty_id", "start_date", "step_id"]}, "createOpptyRecurrenceInput": {"properties": {"apply_recurrence": {"type": "boolean", "example": false, "description": "Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply"}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "condition": {"type": "string", "example": 1, "enum": [1, 2], "description": "Bit Flag field, with limited combination of integer values.\n    \nOptions:\nWon = 1 (0b01)\nLost = 2 (0b10) It is required if the recurrence is set. Conditionally generated opportunity as bitwise operation where bit: 1 bit - won 2 bit - loste.g. if the value is 1 => to generate only when opportunity is won."}, "day": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative.\n\nInteger enum value: 1 - Day1, 2 - Day2, 3 - Day3, 4 - Day4, 5 - Day5, 6 - Day6, 7 - Day7, 8 - Day8, 9 - Day9, 10 - Day10, 11 - Day11, 12 - Day12, 13 - Day13, 14 - Day14, 15 - Day15, 16 - Day16, 17 - Day17, 18 - Day18, 19 - Day19, 20 - Day20, 21 - Day21, 22 - Day22, 23 - Day23, 24 - Day24, 25 - Day25, 26 - Day26, 27 - Day27, 28 - Day28, 29 - Day29, 30 - Day30, 31 - Day31", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31]}, "day_of_week": {"type": "string", "example": 1, "enum": [1, 2, 4, 8, 16, 32, 64], "description": "Bit Flag field, with limited combination of integer values.\n    \nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute."}, "end_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date information. The last date when no more other items should be created."}, "month": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only     for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative.\n\nInteger enum value: 1 - Month1, 2 - Month2, 3 - Month3, 4 - Month4, 5 - Month5, 6 - Month6, 7 - Month7, 8 - Month8, 9 - Month9, 10 - Month10, 11 - Month11, 12 - Month12", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]}, "occur_every": {"type": "integer", "format": "int32", "example": 1, "description": "Generic field wrapping sqlalchemy column, configurable by constructor.\n    Good for one-of fields / generated fields.\n     The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum."}, "occurrences_count": {"type": "integer", "format": "int32", "example": 1, "description": "Whole natural number. The number of remaining occurrences. Each time a new     one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0,     recurrence is stopped. If -1, no limits are applied."}, "oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent opportunity."}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date information. The effective start date of recurrence, which means each     next recurrence must be on or after this date."}, "step_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance. Step related to recurrence. A new opportunity will create     to this step."}, "type": {"type": "integer", "description": "Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative).\n\nInteger enum value: 0 - NotSet, 1 - Daily, 2 - Weekly, 3 - MonthlyRelative, 4 - MonthlyAbsolute, 5 - YearlyRelative, 6 - YearlyAbsolute, 7 - AfterNDays, 8 - AfterNWeeks, 9 - AfterNMonths, 10 - AfterNYears", "example": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]}, "week": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only     for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute.\n\nInteger enum value: -1 - WeekLast, 1 - Week1, 2 - Week2, 3 - Week3, 4 - Week4", "example": -1, "enum": [-1, 1, 2, 3, 4]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["oppty_id", "start_date", "step_id"]}, "updateOpptyRecurrenceInput": {"properties": {"apply_recurrence": {"type": "boolean", "example": false, "description": "Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply"}, "condition": {"type": "string", "example": 1, "enum": [1, 2], "description": "Bit Flag field, with limited combination of integer values.\n    \nOptions:\nWon = 1 (0b01)\nLost = 2 (0b10) It is required if the recurrence is set. Conditionally generated opportunity as bitwise operation where bit: 1 bit - won 2 bit - loste.g. if the value is 1 => to generate only when opportunity is won."}, "day": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative.\n\nInteger enum value: 1 - Day1, 2 - Day2, 3 - Day3, 4 - Day4, 5 - Day5, 6 - Day6, 7 - Day7, 8 - Day8, 9 - Day9, 10 - Day10, 11 - Day11, 12 - Day12, 13 - Day13, 14 - Day14, 15 - Day15, 16 - Day16, 17 - Day17, 18 - Day18, 19 - Day19, 20 - Day20, 21 - Day21, 22 - Day22, 23 - Day23, 24 - Day24, 25 - Day25, 26 - Day26, 27 - Day27, 28 - Day28, 29 - Day29, 30 - Day30, 31 - Day31", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31]}, "day_of_week": {"type": "string", "example": 1, "enum": [1, 2, 4, 8, 16, 32, 64], "description": "Bit Flag field, with limited combination of integer values.\n    \nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute."}, "end_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date information. The last date when no more other items should be created."}, "month": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only     for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative.\n\nInteger enum value: 1 - Month1, 2 - Month2, 3 - Month3, 4 - Month4, 5 - Month5, 6 - Month6, 7 - Month7, 8 - Month8, 9 - Month9, 10 - Month10, 11 - Month11, 12 - Month12", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]}, "occur_every": {"type": "integer", "format": "int32", "example": 1, "description": "Generic field wrapping sqlalchemy column, configurable by constructor.\n    Good for one-of fields / generated fields.\n     The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum."}, "occurrences_count": {"type": "integer", "format": "int32", "example": 1, "description": "Whole natural number. The number of remaining occurrences. Each time a new     one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0,     recurrence is stopped. If -1, no limits are applied."}, "oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent opportunity."}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date information. The effective start date of recurrence, which means each     next recurrence must be on or after this date."}, "step_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance. Step related to recurrence. A new opportunity will create     to this step."}, "type": {"type": "integer", "description": "Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative).\n\nInteger enum value: 0 - NotSet, 1 - Daily, 2 - Weekly, 3 - MonthlyRelative, 4 - MonthlyAbsolute, 5 - YearlyRelative, 6 - YearlyAbsolute, 7 - AfterNDays, 8 - AfterNWeeks, 9 - AfterNMonths, 10 - AfterNYears", "example": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]}, "week": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only     for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute.\n\nInteger enum value: -1 - WeekLast, 1 - Week1, 2 - Week2, 3 - Week3, 4 - Week4", "example": -1, "enum": [-1, 1, 2, 3, 4]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchOpptyRecurrenceInput": {"properties": {"apply_recurrence": {"type": "boolean", "example": false, "description": "Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply"}, "condition": {"type": "string", "example": 1, "enum": [1, 2], "description": "Bit Flag field, with limited combination of integer values.\n    \nOptions:\nWon = 1 (0b01)\nLost = 2 (0b10) It is required if the recurrence is set. Conditionally generated opportunity as bitwise operation where bit: 1 bit - won 2 bit - loste.g. if the value is 1 => to generate only when opportunity is won."}, "day": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative.\n\nInteger enum value: 1 - Day1, 2 - Day2, 3 - Day3, 4 - Day4, 5 - Day5, 6 - Day6, 7 - Day7, 8 - Day8, 9 - Day9, 10 - Day10, 11 - Day11, 12 - Day12, 13 - Day13, 14 - Day14, 15 - Day15, 16 - Day16, 17 - Day17, 18 - Day18, 19 - Day19, 20 - Day20, 21 - Day21, 22 - Day22, 23 - Day23, 24 - Day24, 25 - Day25, 26 - Day26, 27 - Day27, 28 - Day28, 29 - Day29, 30 - Day30, 31 - Day31", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31]}, "day_of_week": {"type": "string", "example": 1, "enum": [1, 2, 4, 8, 16, 32, 64], "description": "Bit Flag field, with limited combination of integer values.\n    \nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute."}, "end_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date information. The last date when no more other items should be created."}, "month": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only     for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative.\n\nInteger enum value: 1 - Month1, 2 - Month2, 3 - Month3, 4 - Month4, 5 - Month5, 6 - Month6, 7 - Month7, 8 - Month8, 9 - Month9, 10 - Month10, 11 - Month11, 12 - Month12", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]}, "occur_every": {"type": "integer", "format": "int32", "example": 1, "description": "Generic field wrapping sqlalchemy column, configurable by constructor.\n    Good for one-of fields / generated fields.\n     The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum."}, "occurrences_count": {"type": "integer", "format": "int32", "example": 1, "description": "Whole natural number. The number of remaining occurrences. Each time a new     one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0,     recurrence is stopped. If -1, no limits are applied."}, "oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent opportunity."}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date information. The effective start date of recurrence, which means each     next recurrence must be on or after this date."}, "step_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance. Step related to recurrence. A new opportunity will create     to this step."}, "type": {"type": "integer", "description": "Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative).\n\nInteger enum value: 0 - NotSet, 1 - Daily, 2 - Weekly, 3 - MonthlyRelative, 4 - MonthlyAbsolute, 5 - YearlyRelative, 6 - YearlyAbsolute, 7 - AfterNDays, 8 - AfterNWeeks, 9 - AfterNMonths, 10 - AfterNYears", "example": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]}, "week": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only     for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute.\n\nInteger enum value: -1 - WeekLast, 1 - Week1, 2 - Week2, 3 - Week3, 4 - Week4", "example": -1, "enum": [-1, 1, 2, 3, 4]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "OpptyRevenueSchedule": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity. Must match with Opportunity id.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted."}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "cancelation_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when the revenue schedule was cancelled. Empty for active schedules."}, "period_count": {"type": "integer", "format": "int32", "example": 1, "description": "Number of periods the opportunity value is split into."}, "period_type": {"type": "integer", "description": "Length of each period (e.g. Monthly, Quarterly, Yearly).\n\nInteger enum value: 1 - Month, 2 - Quarter, 3 - Year", "example": 1, "enum": [1, 2, 3]}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when revenue recognition for the opportunity begins."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "periods": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to OpptyRevenueSchedulePeriod. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyRevenueSchedulePeriod' object for properties."}, "description": "Periods produced by this revenue schedule, ordered by date."}}, "required": ["is_delete_protected", "id"]}, "createOpptyRevenueScheduleInput": {"properties": {"id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity. Must match with Opportunity id.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted."}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "cancelation_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when the revenue schedule was cancelled. Empty for active schedules."}, "period_count": {"type": "integer", "format": "int32", "example": 1, "description": "Number of periods the opportunity value is split into."}, "period_type": {"type": "integer", "description": "Length of each period (e.g. Monthly, Quarterly, Yearly).\n\nInteger enum value: 1 - Month, 2 - Quarter, 3 - Year", "example": 1, "enum": [1, 2, 3]}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when revenue recognition for the opportunity begins."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["id"]}, "updateOpptyRevenueScheduleInput": {"properties": {"is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted."}, "cancelation_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when the revenue schedule was cancelled. Empty for active schedules."}, "period_count": {"type": "integer", "format": "int32", "example": 1, "description": "Number of periods the opportunity value is split into."}, "period_type": {"type": "integer", "description": "Length of each period (e.g. Monthly, Quarterly, Yearly).\n\nInteger enum value: 1 - Month, 2 - Quarter, 3 - Year", "example": 1, "enum": [1, 2, 3]}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when revenue recognition for the opportunity begins."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchOpptyRevenueScheduleInput": {"properties": {"is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted."}, "cancelation_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when the revenue schedule was cancelled. Empty for active schedules."}, "period_count": {"type": "integer", "format": "int32", "example": 1, "description": "Number of periods the opportunity value is split into."}, "period_type": {"type": "integer", "description": "Length of each period (e.g. Monthly, Quarterly, Yearly).\n\nInteger enum value: 1 - Month, 2 - Quarter, 3 - Year", "example": 1, "enum": [1, 2, 3]}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when revenue recognition for the opportunity begins."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "OpptyRevenueSchedulePeriod": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "oppty_revenue_schedule": {"type": "string", "format": "uri", "description": "Parent revenue schedule this period belongs to.\n\nRelation to OpptyRevenueSchedule. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyRevenueSchedule' object for properties."}, "date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Recognition date of this period."}, "oppty_revenue_schedule_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent revenue schedule."}, "transaction_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier linking the period to the recognition transaction."}, "value": {"type": "number", "format": "double", "example": 4.32, "description": "Amount recognised in this period."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "oppty_revenue_schedule", "oppty_revenue_schedule_id", "transaction_id"]}, "createOpptyRevenueSchedulePeriodInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "oppty_revenue_schedule": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Parent revenue schedule this period belongs to.\n\nRelation to OpptyRevenueSchedule, see: 'createOpptyRevenueScheduleInput' object for properties."}, "date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Recognition date of this period."}, "oppty_revenue_schedule_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent revenue schedule."}, "transaction_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier linking the period to the recognition transaction."}, "value": {"type": "number", "format": "double", "example": 4.32, "description": "Amount recognised in this period."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["oppty_revenue_schedule", "oppty_revenue_schedule_id", "transaction_id"]}, "updateOpptyRevenueSchedulePeriodInput": {"properties": {"oppty_revenue_schedule": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Parent revenue schedule this period belongs to.\n\nRelation to OpptyRevenueSchedule, see: 'updateOpptyRevenueScheduleInput' object for properties."}, "date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Recognition date of this period."}, "oppty_revenue_schedule_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent revenue schedule."}, "transaction_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier linking the period to the recognition transaction."}, "value": {"type": "number", "format": "double", "example": 4.32, "description": "Amount recognised in this period."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchOpptyRevenueSchedulePeriodInput": {"properties": {"oppty_revenue_schedule": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Parent revenue schedule this period belongs to.\n\nRelation to OpptyRevenueSchedule, see: 'updateOpptyRevenueScheduleInput' object for properties."}, "date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Recognition date of this period."}, "oppty_revenue_schedule_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent revenue schedule."}, "transaction_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier linking the period to the recognition transaction."}, "value": {"type": "number", "format": "double", "example": 4.32, "description": "Amount recognised in this period."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ParentAccountRelationType": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "child_label": {"type": "string", "example": "string", "description": "Label shown for the child side of the parent-child account relation (e.g. \"Subsidiary\" when the parent is a holding company)."}, "parent_label": {"type": "string", "example": "string", "description": "Label shown for the parent side of the parent-child account relation (e.g. \"Parent company\")."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "child_label", "parent_label"]}, "createParentAccountRelationTypeInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "child_label": {"type": "string", "example": "string", "description": "Label shown for the child side of the parent-child account relation (e.g. \"Subsidiary\" when the parent is a holding company)."}, "parent_label": {"type": "string", "example": "string", "description": "Label shown for the parent side of the parent-child account relation (e.g. \"Parent company\")."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["child_label", "parent_label"]}, "updateParentAccountRelationTypeInput": {"properties": {"child_label": {"type": "string", "example": "string", "description": "Label shown for the child side of the parent-child account relation (e.g. \"Subsidiary\" when the parent is a holding company)."}, "parent_label": {"type": "string", "example": "string", "description": "Label shown for the parent side of the parent-child account relation (e.g. \"Parent company\")."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchParentAccountRelationTypeInput": {"properties": {"child_label": {"type": "string", "example": "string", "description": "Label shown for the child side of the parent-child account relation (e.g. \"Subsidiary\" when the parent is a holding company)."}, "parent_label": {"type": "string", "example": "string", "description": "Label shown for the parent side of the parent-child account relation (e.g. \"Parent company\")."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Phone": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "owner": {"type": "string", "format": "uri", "description": "User the phone is assigned to, when the phone belongs to a specific user (personal calling/SMS line).\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "error_code": {"type": "integer", "format": "int32", "example": 1, "description": "Error code recorded for the phone, set on integration failures (e.g. provider rejected the last send) or when the user disables the integration; empty when the phone is healthy."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the assigned user, or empty when the phone is a company-level resource."}, "phone_number": {"type": "string", "example": "string", "description": "Phone number in E.164 format (e.g. \"+12025550123\")."}, "twilio_caller_sid": {"type": "string", "example": "string", "description": "External caller identifier from the calling provider (e.g. Twilio caller SID)."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Calling, 2 - CallingSmsUnassigned, 3 - CallingSmsPersonal, 4 - CallingSmsCompany, 5 - WhatsAppPersonal, 6 - WhatsAppCompany", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "message_forwarding_email": {"type": "string", "example": "string", "description": "Email address that incoming text messages to this phone are forwarded to. Empty when forwarding is not configured."}, "call_forwarding_phone": {"type": "string", "example": "string", "description": "Phone number that incoming calls/SMS to this phone are forwarded to. Empty when forwarding is not configured."}, "enabled": {"type": "boolean", "example": false, "description": "False when the user has disabled the calling/SMS integration on this phone (error_code is set to indicate user disablement); true otherwise."}}, "required": ["is_delete_protected", "id", "name", "type", "enabled"]}, "createPhoneInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "error_code": {"type": "integer", "format": "int32", "example": 1, "description": "Error code recorded for the phone, set on integration failures (e.g. provider rejected the last send) or when the user disables the integration; empty when the phone is healthy."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the assigned user, or empty when the phone is a company-level resource."}, "phone_number": {"type": "string", "example": "string", "description": "Phone number in E.164 format (e.g. \"+12025550123\")."}, "twilio_caller_sid": {"type": "string", "example": "string", "description": "External caller identifier from the calling provider (e.g. Twilio caller SID)."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Calling, 2 - CallingSmsUnassigned, 3 - CallingSmsPersonal, 4 - CallingSmsCompany, 5 - WhatsAppPersonal, 6 - WhatsAppCompany", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "enabled": {"type": "boolean", "example": false, "description": "False when the user has disabled the calling/SMS integration on this phone (error_code is set to indicate user disablement); true otherwise."}}, "required": ["name", "type", "enabled"]}, "updatePhoneInput": {"properties": {"error_code": {"type": "integer", "format": "int32", "example": 1, "description": "Error code recorded for the phone, set on integration failures (e.g. provider rejected the last send) or when the user disables the integration; empty when the phone is healthy."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the assigned user, or empty when the phone is a company-level resource."}, "phone_number": {"type": "string", "example": "string", "description": "Phone number in E.164 format (e.g. \"+12025550123\")."}, "twilio_caller_sid": {"type": "string", "example": "string", "description": "External caller identifier from the calling provider (e.g. Twilio caller SID)."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Calling, 2 - CallingSmsUnassigned, 3 - CallingSmsPersonal, 4 - CallingSmsCompany, 5 - WhatsAppPersonal, 6 - WhatsAppCompany", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "enabled": {"type": "boolean", "example": false, "description": "False when the user has disabled the calling/SMS integration on this phone (error_code is set to indicate user disablement); true otherwise."}}}, "batchPhoneInput": {"properties": {"error_code": {"type": "integer", "format": "int32", "example": 1, "description": "Error code recorded for the phone, set on integration failures (e.g. provider rejected the last send) or when the user disables the integration; empty when the phone is healthy."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the assigned user, or empty when the phone is a company-level resource."}, "phone_number": {"type": "string", "example": "string", "description": "Phone number in E.164 format (e.g. \"+12025550123\")."}, "twilio_caller_sid": {"type": "string", "example": "string", "description": "External caller identifier from the calling provider (e.g. Twilio caller SID)."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Calling, 2 - CallingSmsUnassigned, 3 - CallingSmsPersonal, 4 - CallingSmsCompany, 5 - WhatsAppPersonal, 6 - WhatsAppCompany", "example": 1, "enum": [1, 2, 3, 4, 5, 6]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "enabled": {"type": "boolean", "example": false, "description": "False when the user has disabled the calling/SMS integration on this phone (error_code is set to indicate user disablement); true otherwise."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Pipeline": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the pipeline label, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "steps": {"type": "array", "items": {"$ref": "#/components/schemas/batchStepInput"}, "description": "Steps associated with this Pipeline."}, "opportunity_types": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to OpportunityType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpportunityType' object for properties."}, "description": "Opportunity types that follow this pipeline."}}, "required": ["is_delete_protected", "id", "color", "name", "steps", "opportunity_types"]}, "createPipelineInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the pipeline label, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "steps": {"type": "array", "items": {"$ref": "#/components/schemas/batchStepInput"}, "description": "Steps associated with this Pipeline."}}, "required": ["color", "name", "steps"]}, "updatePipelineInput": {"properties": {"color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the pipeline label, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "steps": {"type": "array", "items": {"$ref": "#/components/schemas/batchStepInput"}, "description": "Steps associated with this Pipeline."}}}, "batchPipelineInput": {"properties": {"color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the pipeline label, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "steps": {"type": "array", "items": {"$ref": "#/components/schemas/batchStepInput"}, "description": "Steps associated with this Pipeline."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Process": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "owner": {"type": "string", "format": "uri", "description": "User who owns the process.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "ai_conversation": {"type": "object", "description": "AI assistant conversation associated with the process (e.g. records of AI-driven schema generation)."}, "deactivation_reason": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoReason, 1 - Manual, 2 - TooManyErrors, 3 - DisabledFeature", "example": 0, "enum": [0, 1, 2, 3]}, "description": {"type": "string", "example": "string", "description": "Free-text description shown alongside the process."}, "is_enabled": {"type": "boolean", "example": false, "description": "When true, the process actively responds to its trigger; when false, the process is paused. Toggle via enable/disable mutations."}, "last_schema_change": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent change to settings."}, "last_status_change": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent change to is_enabled."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "settings": {"type": "object", "description": "Process schema as a JSON object conforming to the ProcessSchema type \u2014 trigger, nodes and settings. Built via the process builder; validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/processschema.doc.html"}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Personal, 2 - Space", "example": 1, "enum": [1, 2]}, "activity_logs": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ProcessActivityLog. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProcessActivityLog' object for properties."}, "description": "Activity log runs (one per process execution) recorded for this process."}, "tags": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to TagRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TagRelation' object for properties."}, "description": "Tags attached to the process for organisation/filtering."}, "activity": {"type": "object", "description": "Activity timeline for the last 24 hours showing per-hour counts of successful, warning, and error process runs."}, "documents": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties."}, "description": "Files attached to the process (e.g. process documentation)."}}, "required": ["is_delete_protected", "id", "owner", "name", "owner_id", "type", "activity"]}, "createProcessInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "ai_conversation": {"type": "object", "description": "AI assistant conversation associated with the process (e.g. records of AI-driven schema generation)."}, "description": {"type": "string", "example": "string", "description": "Free-text description shown alongside the process."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "settings": {"type": "object", "description": "Process schema as a JSON object conforming to the ProcessSchema type \u2014 trigger, nodes and settings. Built via the process builder; validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/processschema.doc.html"}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Personal, 2 - Space", "example": 1, "enum": [1, 2]}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'createTagRelationInput' object for properties."}, "description": "Tags attached to the process for organisation/filtering."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties."}, "description": "Files attached to the process (e.g. process documentation)."}}, "required": ["name", "owner_id", "type"]}, "updateProcessInput": {"properties": {"ai_conversation": {"type": "object", "description": "AI assistant conversation associated with the process (e.g. records of AI-driven schema generation)."}, "description": {"type": "string", "example": "string", "description": "Free-text description shown alongside the process."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "settings": {"type": "object", "description": "Process schema as a JSON object conforming to the ProcessSchema type \u2014 trigger, nodes and settings. Built via the process builder; validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/processschema.doc.html"}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Personal, 2 - Space", "example": 1, "enum": [1, 2]}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'updateTagRelationInput' object for properties."}, "description": "Tags attached to the process for organisation/filtering."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Files attached to the process (e.g. process documentation)."}}}, "batchProcessInput": {"properties": {"ai_conversation": {"type": "object", "description": "AI assistant conversation associated with the process (e.g. records of AI-driven schema generation)."}, "description": {"type": "string", "example": "string", "description": "Free-text description shown alongside the process."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "settings": {"type": "object", "description": "Process schema as a JSON object conforming to the ProcessSchema type \u2014 trigger, nodes and settings. Built via the process builder; validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/processschema.doc.html"}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Personal, 2 - Space", "example": 1, "enum": [1, 2]}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'updateTagRelationInput' object for properties."}, "description": "Tags attached to the process for organisation/filtering."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Files attached to the process (e.g. process documentation)."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ProcessActivityLog": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "actor": {"type": "string", "format": "uri", "description": "User who triggered the run, or empty for runs triggered by automation.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "application": {"type": "string", "format": "uri", "description": "Application context the run was triggered in.\n\nRelation to Application. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Application' object for properties."}, "process": {"type": "string", "format": "uri", "description": "Process whose execution this log records.\n\nRelation to Process. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Process' object for properties."}, "actor_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the actor."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the application."}, "cpu_run_time": {"type": "number", "format": "double", "example": "4.32", "description": "Total CPU time consumed by the run, in seconds."}, "end_time": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the run finished. Empty while the run is still in progress (e.g. waiting on scheduled actions)."}, "is_test_run": {"type": "boolean", "example": false, "description": "True when the run was triggered as a test (results are not persisted to records)."}, "parent_process_ids": {"type": "object", "description": "Ids of parent processes that triggered this run, ordered from outermost to innermost. Empty for top-level runs."}, "process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the process."}, "run_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier grouping all activity logs that share the same root process run, including chained sub-process runs."}, "start_time": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the run started."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}, "lines": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ProcessActivityLogLine. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProcessActivityLogLine' object for properties."}, "description": "Activity log lines describing each step taken in this run (visible only)."}, "record_name": {"type": "string", "example": "string", "description": "Name of the trigger record (extracted from the first log line) for display in activity log lists."}}, "required": ["is_delete_protected", "id", "application", "process", "application_id", "process_id", "start_time", "status"]}, "createProcessActivityLogInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "actor_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the actor."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the application."}, "cpu_run_time": {"type": "number", "format": "double", "example": "4.32", "description": "Total CPU time consumed by the run, in seconds."}, "end_time": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the run finished. Empty while the run is still in progress (e.g. waiting on scheduled actions)."}, "is_test_run": {"type": "boolean", "example": false, "description": "True when the run was triggered as a test (results are not persisted to records)."}, "parent_process_ids": {"type": "object", "description": "Ids of parent processes that triggered this run, ordered from outermost to innermost. Empty for top-level runs."}, "process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the process."}, "run_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier grouping all activity logs that share the same root process run, including chained sub-process runs."}, "start_time": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the run started."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}}, "required": ["application_id", "process_id", "start_time", "status"]}, "updateProcessActivityLogInput": {"properties": {"actor_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the actor."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the application."}, "cpu_run_time": {"type": "number", "format": "double", "example": "4.32", "description": "Total CPU time consumed by the run, in seconds."}, "end_time": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the run finished. Empty while the run is still in progress (e.g. waiting on scheduled actions)."}, "is_test_run": {"type": "boolean", "example": false, "description": "True when the run was triggered as a test (results are not persisted to records)."}, "parent_process_ids": {"type": "object", "description": "Ids of parent processes that triggered this run, ordered from outermost to innermost. Empty for top-level runs."}, "process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the process."}, "run_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier grouping all activity logs that share the same root process run, including chained sub-process runs."}, "start_time": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the run started."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}}}, "batchProcessActivityLogInput": {"properties": {"actor_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the actor."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the application."}, "cpu_run_time": {"type": "number", "format": "double", "example": "4.32", "description": "Total CPU time consumed by the run, in seconds."}, "end_time": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the run finished. Empty while the run is still in progress (e.g. waiting on scheduled actions)."}, "is_test_run": {"type": "boolean", "example": false, "description": "True when the run was triggered as a test (results are not persisted to records)."}, "parent_process_ids": {"type": "object", "description": "Ids of parent processes that triggered this run, ordered from outermost to innermost. Empty for top-level runs."}, "process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the process."}, "run_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier grouping all activity logs that share the same root process run, including chained sub-process runs."}, "start_time": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the run started."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ProcessActivityLogLine": {"properties": {"formatted_text": {"type": "string", "example": "string", "description": "Human-readable rendering of the log line, prefixed with the line's timestamp and (when applicable) the parent record id."}, "is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "process_activity_log": {"type": "string", "format": "uri", "description": "Activity log run this line belongs to.\n\nRelation to ProcessActivityLog. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProcessActivityLog' object for properties."}, "executed_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run."}, "is_visible": {"type": "boolean", "example": false, "description": "True when the line is shown in the activity log UI; false for internal-only lines."}, "process_activity_log_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the activity log."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the line within its log run."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}}, "required": ["formatted_text", "is_delete_protected", "id", "process_activity_log", "process_activity_log_id", "sort_order"]}, "createProcessActivityLogLineInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "executed_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run."}, "is_visible": {"type": "boolean", "example": false, "description": "True when the line is shown in the activity log UI; false for internal-only lines."}, "process_activity_log_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the activity log."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the line within its log run."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}}, "required": ["process_activity_log_id", "sort_order"]}, "updateProcessActivityLogLineInput": {"properties": {"executed_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run."}, "is_visible": {"type": "boolean", "example": false, "description": "True when the line is shown in the activity log UI; false for internal-only lines."}, "process_activity_log_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the activity log."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the line within its log run."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}}}, "batchProcessActivityLogLineInput": {"properties": {"executed_at": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run."}, "is_visible": {"type": "boolean", "example": false, "description": "True when the line is shown in the activity log UI; false for internal-only lines."}, "process_activity_log_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the activity log."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the line within its log run."}, "status": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired", "example": 1, "enum": [1, 2, 3, 4, 5]}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ProcessTemplate": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "description": {"type": "string", "example": "string", "description": "Free-text description of what the template does."}, "is_recommended": {"type": "boolean", "example": false, "description": "True when the platform recommends this template (highlighted in the template gallery)."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "object", "description": "Process schema shipped by the template, as a JSON object conforming to the ProcessSchema type (trigger, nodes, settings). Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/processschema.doc.html"}, "documents": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties."}, "description": "Files attached to the template (e.g. reference documents, screenshots)."}, "action_types": {"type": "array", "items": {"type": "string", "example": "ArchiveRecord", "enum": ["ArchiveRecord", "CreateRecord", "ManualTrigger", "RecordChangedTrigger", "ScheduledTrigger", "SendEmail", "SendWebhook", "UpdateRecord"]}, "description": "Action-type icons present in the template schema, used for filtering templates by capability (e.g. SendEmail, CreateRecord, Webhook)."}}, "required": ["is_delete_protected", "id", "name", "settings"]}, "createProcessTemplateInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "description": {"type": "string", "example": "string", "description": "Free-text description of what the template does."}, "is_recommended": {"type": "boolean", "example": false, "description": "True when the platform recommends this template (highlighted in the template gallery)."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "object", "description": "Process schema shipped by the template, as a JSON object conforming to the ProcessSchema type (trigger, nodes, settings). Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/processschema.doc.html"}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties."}, "description": "Files attached to the template (e.g. reference documents, screenshots)."}}, "required": ["name", "settings"]}, "updateProcessTemplateInput": {"properties": {"description": {"type": "string", "example": "string", "description": "Free-text description of what the template does."}, "is_recommended": {"type": "boolean", "example": false, "description": "True when the platform recommends this template (highlighted in the template gallery)."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "object", "description": "Process schema shipped by the template, as a JSON object conforming to the ProcessSchema type (trigger, nodes, settings). Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/processschema.doc.html"}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Files attached to the template (e.g. reference documents, screenshots)."}}}, "batchProcessTemplateInput": {"properties": {"description": {"type": "string", "example": "string", "description": "Free-text description of what the template does."}, "is_recommended": {"type": "boolean", "example": false, "description": "True when the platform recommends this template (highlighted in the template gallery)."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "object", "description": "Process schema shipped by the template, as a JSON object conforming to the ProcessSchema type (trigger, nodes, settings). Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/processschema.doc.html"}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Files attached to the template (e.g. reference documents, screenshots)."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Product": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "currency_exchange_rates_list": {"type": "string", "format": "uri", "description": "Currency exchange rate list used to convert monetary fields linked to this product. Empty to inherit the team space default.\n\nRelation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRatesList' object for properties."}, "picture": {"type": "string", "format": "uri", "description": "Product picture.\n\nRelation to CloudObject. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObject' object for properties."}, "product_category": {"type": "string", "format": "uri", "description": "Product category this product belongs to. Categories form a hierarchy used in the catalog browser.\n\nRelation to ProductCategory. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProductCategory' object for properties."}, "product_type": {"type": "string", "format": "uri", "description": "Product type that classifies this product. Product types are configurable per team space and drive which form, fields and product-line behavior apply.\n\nRelation to ProductType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProductType' object for properties."}, "allowed_pipelines": {"type": "integer", "description": "Whether this product can be added to all pipelines or only the explicitly linked subset (see product_pipeline_relations).\n\nInteger enum value: 1 - All, 2 - Selected", "example": 1, "enum": [1, 2]}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this product."}, "description": {"type": "string", "example": "string", "description": "Free-form description of the product."}, "name": {"type": "string", "example": "string", "description": "Name of the product, shown in catalogues and pickers."}, "picture_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product picture document."}, "product_category_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product category."}, "product_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product type."}, "sku": {"type": "string", "example": "string", "description": "Stock-keeping unit (SKU) identifier of the product. Must be unique across products."}, "unit_symbol": {"type": "string", "example": "string", "description": "Unit of measure shown next to product quantities (e.g. pcs, kg, hours)."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "product_pipeline_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ProductPipelineRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProductPipelineRelation' object for properties."}, "description": "Deprecated pipeline connection."}, "product_pipelines": {"type": "object", "properties": {"pipelines": {"type": "array", "items": {"type": "string", "description": "An id of pipeline entity.", "format": "uuid"}}, "allowed_pipelines": {"type": "integer", "description": "Whether this product can be added to all pipelines or only the explicitly linked subset (see product_pipeline_relations).\n\nInteger enum value: 1 - All, 2 - Selected", "example": 1, "enum": [1, 2]}}, "required": ["pipelines", "allowed_pipelines"], "description": "Configuration of Pipelines where the Product can be used."}, "formatted_name": {"type": "string", "example": "string", "description": "Display version of the product name, used in lists and references."}, "oppty_product_relation_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product line-item type derived from product_type. Used as a filter when listing relations on opportunities and quotes. Read-only."}}, "required": ["is_delete_protected", "id", "product_type", "name", "formatted_name", "oppty_product_relation_type_id"]}, "createProductInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "picture": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Product picture.\n\nRelation to CloudObject, see: 'createCloudObjectInput' object for properties."}, "allowed_pipelines": {"type": "integer", "description": "Whether this product can be added to all pipelines or only the explicitly linked subset (see product_pipeline_relations).\n\nInteger enum value: 1 - All, 2 - Selected", "example": 1, "enum": [1, 2]}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this product."}, "description": {"type": "string", "example": "string", "description": "Free-form description of the product."}, "name": {"type": "string", "example": "string", "description": "Name of the product, shown in catalogues and pickers."}, "picture_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product picture document."}, "product_category_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product category."}, "product_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product type."}, "sku": {"type": "string", "example": "string", "description": "Stock-keeping unit (SKU) identifier of the product. Must be unique across products."}, "unit_symbol": {"type": "string", "example": "string", "description": "Unit of measure shown next to product quantities (e.g. pcs, kg, hours)."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "product_pipeline_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProductPipelineRelation, see: 'createProductPipelineRelationInput' object for properties."}, "description": "Deprecated pipeline connection."}, "product_pipelines": {"type": "object", "properties": {"pipelines": {"type": "array", "items": {"type": "string", "description": "An id of pipeline entity.", "format": "uuid"}}, "allowed_pipelines": {"type": "integer", "description": "Whether this product can be added to all pipelines or only the explicitly linked subset (see product_pipeline_relations).\n\nInteger enum value: 1 - All, 2 - Selected", "example": 1, "enum": [1, 2]}}, "required": ["pipelines", "allowed_pipelines"], "description": "Configuration of Pipelines where the Product can be used."}, "picture_source_url": {"type": "string", "example": "string", "description": "Source url of picture. If filled url is loaded and checked content. Currently supports only pictures!!"}}, "required": ["name"]}, "updateProductInput": {"properties": {"picture": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Product picture.\n\nRelation to CloudObject, see: 'updateCloudObjectInput' object for properties."}, "allowed_pipelines": {"type": "integer", "description": "Whether this product can be added to all pipelines or only the explicitly linked subset (see product_pipeline_relations).\n\nInteger enum value: 1 - All, 2 - Selected", "example": 1, "enum": [1, 2]}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this product."}, "description": {"type": "string", "example": "string", "description": "Free-form description of the product."}, "name": {"type": "string", "example": "string", "description": "Name of the product, shown in catalogues and pickers."}, "picture_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product picture document."}, "product_category_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product category."}, "product_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product type."}, "sku": {"type": "string", "example": "string", "description": "Stock-keeping unit (SKU) identifier of the product. Must be unique across products."}, "unit_symbol": {"type": "string", "example": "string", "description": "Unit of measure shown next to product quantities (e.g. pcs, kg, hours)."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "product_pipeline_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProductPipelineRelation, see: 'updateProductPipelineRelationInput' object for properties."}, "description": "Deprecated pipeline connection."}, "product_pipelines": {"type": "object", "properties": {"pipelines": {"type": "array", "items": {"type": "string", "description": "An id of pipeline entity.", "format": "uuid"}}, "allowed_pipelines": {"type": "integer", "description": "Whether this product can be added to all pipelines or only the explicitly linked subset (see product_pipeline_relations).\n\nInteger enum value: 1 - All, 2 - Selected", "example": 1, "enum": [1, 2]}}, "required": ["pipelines", "allowed_pipelines"], "description": "Configuration of Pipelines where the Product can be used."}, "picture_source_url": {"type": "string", "example": "string", "description": "Source url of picture. If filled url is loaded and checked content. Currently supports only pictures!!"}}}, "batchProductInput": {"properties": {"picture": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Product picture.\n\nRelation to CloudObject, see: 'updateCloudObjectInput' object for properties."}, "allowed_pipelines": {"type": "integer", "description": "Whether this product can be added to all pipelines or only the explicitly linked subset (see product_pipeline_relations).\n\nInteger enum value: 1 - All, 2 - Selected", "example": 1, "enum": [1, 2]}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this product."}, "description": {"type": "string", "example": "string", "description": "Free-form description of the product."}, "name": {"type": "string", "example": "string", "description": "Name of the product, shown in catalogues and pickers."}, "picture_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product picture document."}, "product_category_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product category."}, "product_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product type."}, "sku": {"type": "string", "example": "string", "description": "Stock-keeping unit (SKU) identifier of the product. Must be unique across products."}, "unit_symbol": {"type": "string", "example": "string", "description": "Unit of measure shown next to product quantities (e.g. pcs, kg, hours)."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "product_pipeline_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProductPipelineRelation, see: 'updateProductPipelineRelationInput' object for properties."}, "description": "Deprecated pipeline connection."}, "product_pipelines": {"type": "object", "properties": {"pipelines": {"type": "array", "items": {"type": "string", "description": "An id of pipeline entity.", "format": "uuid"}}, "allowed_pipelines": {"type": "integer", "description": "Whether this product can be added to all pipelines or only the explicitly linked subset (see product_pipeline_relations).\n\nInteger enum value: 1 - All, 2 - Selected", "example": 1, "enum": [1, 2]}}, "required": ["pipelines", "allowed_pipelines"], "description": "Configuration of Pipelines where the Product can be used."}, "picture_source_url": {"type": "string", "example": "string", "description": "Source url of picture. If filled url is loaded and checked content. Currently supports only pictures!!"}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ProductCategory": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "parent": {"type": "string", "format": "uri", "description": "Parent category in the catalog hierarchy. Empty for top-level categories.\n\nRelation to ProductCategory. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProductCategory' object for properties."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "parent_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent category."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "product_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to Product. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Product' object for properties."}, "description": "All Products in this category."}}, "required": ["is_delete_protected", "id", "name"]}, "createProductCategoryInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "parent_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent category."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "product_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to Product, see: 'createProductInput' object for properties."}, "description": "All Products in this category."}}, "required": ["name"]}, "updateProductCategoryInput": {"properties": {"name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "parent_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent category."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "product_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to Product, see: 'updateProductInput' object for properties."}, "description": "All Products in this category."}}}, "batchProductCategoryInput": {"properties": {"name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "parent_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent category."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "product_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to Product, see: 'updateProductInput' object for properties."}, "description": "All Products in this category."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ProductDataExRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "data": {"type": "string", "format": "uri", "description": "External data record (Data entity) holding the enrichment payload.\n\nRelation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties."}, "product": {"type": "string", "format": "uri", "description": "Product this enrichment record applies to.\n\nRelation to Product. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Product' object for properties."}, "data_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the external data record."}, "data_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier of the data set the enrichment record originates from."}, "product_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "data", "product", "data_id", "data_set_id", "product_id"]}, "ProductPipelineRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "pipeline": {"type": "string", "format": "uri", "description": "Pipeline in which the product can be added as a line item.\n\nRelation to Pipeline. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Pipeline' object for properties."}, "product": {"type": "string", "format": "uri", "description": "Product available in the linked pipeline.\n\nRelation to Product. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Product' object for properties."}, "pipeline_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the pipeline."}, "product_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "pipeline", "product", "pipeline_id", "product_id"]}, "createProductPipelineRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "pipeline_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the pipeline."}, "product_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["pipeline_id", "product_id"]}, "updateProductPipelineRelationInput": {"properties": {"pipeline_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the pipeline."}, "product_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchProductPipelineRelationInput": {"properties": {"pipeline_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the pipeline."}, "product_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ProductPriceList": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "description": {"type": "string", "example": "string", "description": "Free-form description of the price list."}, "end_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when the price list expires. Empty means open-ended."}, "is_active": {"type": "boolean", "example": false, "description": "Master switch for the price list. Inactive price lists are not applied to opportunities or quotes regardless of dates."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "rules": {"type": "object", "description": "Filter expression \u2014 a FieldFilter JSON object \u2014 deciding which records (e.g. accounts, opportunities) the price list applies to. Empty when it applies to all records. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/fieldfilter.doc.html"}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when the price list becomes active. Empty means immediately."}, "type": {"type": "integer", "description": "Distribution model of the price list (e.g. List, Promotion, Discount).\n\nInteger enum value: 1 - Standard, 2 - Scheduled", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "product_price_list_prices": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ProductPriceListPrice. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProductPriceListPrice' object for properties."}, "description": "Per-product, per-currency prices configured in the price list."}}, "required": ["is_delete_protected", "id", "name"]}, "createProductPriceListInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "description": {"type": "string", "example": "string", "description": "Free-form description of the price list."}, "end_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when the price list expires. Empty means open-ended."}, "is_active": {"type": "boolean", "example": false, "description": "Master switch for the price list. Inactive price lists are not applied to opportunities or quotes regardless of dates."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "rules": {"type": "object", "description": "Filter expression \u2014 a FieldFilter JSON object \u2014 deciding which records (e.g. accounts, opportunities) the price list applies to. Empty when it applies to all records. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/fieldfilter.doc.html"}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when the price list becomes active. Empty means immediately."}, "type": {"type": "integer", "description": "Distribution model of the price list (e.g. List, Promotion, Discount).\n\nInteger enum value: 1 - Standard, 2 - Scheduled", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "product_price_list_prices": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProductPriceListPrice, see: 'createProductPriceListPriceInput' object for properties."}, "description": "Per-product, per-currency prices configured in the price list."}}, "required": ["name"]}, "updateProductPriceListInput": {"properties": {"description": {"type": "string", "example": "string", "description": "Free-form description of the price list."}, "end_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when the price list expires. Empty means open-ended."}, "is_active": {"type": "boolean", "example": false, "description": "Master switch for the price list. Inactive price lists are not applied to opportunities or quotes regardless of dates."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "rules": {"type": "object", "description": "Filter expression \u2014 a FieldFilter JSON object \u2014 deciding which records (e.g. accounts, opportunities) the price list applies to. Empty when it applies to all records. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/fieldfilter.doc.html"}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when the price list becomes active. Empty means immediately."}, "type": {"type": "integer", "description": "Distribution model of the price list (e.g. List, Promotion, Discount).\n\nInteger enum value: 1 - Standard, 2 - Scheduled", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "product_price_list_prices": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProductPriceListPrice, see: 'updateProductPriceListPriceInput' object for properties."}, "description": "Per-product, per-currency prices configured in the price list."}}}, "batchProductPriceListInput": {"properties": {"description": {"type": "string", "example": "string", "description": "Free-form description of the price list."}, "end_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when the price list expires. Empty means open-ended."}, "is_active": {"type": "boolean", "example": false, "description": "Master switch for the price list. Inactive price lists are not applied to opportunities or quotes regardless of dates."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "rules": {"type": "object", "description": "Filter expression \u2014 a FieldFilter JSON object \u2014 deciding which records (e.g. accounts, opportunities) the price list applies to. Empty when it applies to all records. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/fieldfilter.doc.html"}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when the price list becomes active. Empty means immediately."}, "type": {"type": "integer", "description": "Distribution model of the price list (e.g. List, Promotion, Discount).\n\nInteger enum value: 1 - Standard, 2 - Scheduled", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "product_price_list_prices": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProductPriceListPrice, see: 'updateProductPriceListPriceInput' object for properties."}, "description": "Per-product, per-currency prices configured in the price list."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ProductPriceListPrice": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "currency": {"type": "string", "format": "uri", "description": "Currency the price value is denominated in.\n\nRelation to Currency. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Currency' object for properties."}, "product": {"type": "string", "format": "uri", "description": "Product the price applies to.\n\nRelation to Product. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Product' object for properties."}, "product_price_list": {"type": "string", "format": "uri", "description": "Price list the price belongs to.\n\nRelation to ProductPriceList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProductPriceList' object for properties."}, "currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency."}, "price": {"type": "number", "format": "double", "example": 4.32, "description": "Price amount stored at 6-decimal precision; values set via the API are rounded."}, "product_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product."}, "product_price_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the price list."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-price access controls (e.g. which user roles can override this price). Stored as a JSON object."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "currency", "product", "product_price_list", "currency_id", "product_id", "product_price_list_id", "settings"]}, "createProductPriceListPriceInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency."}, "price": {"type": "number", "format": "double", "example": 4.32, "description": "Price amount stored at 6-decimal precision; values set via the API are rounded."}, "product_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product."}, "product_price_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the price list."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-price access controls (e.g. which user roles can override this price). Stored as a JSON object."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["currency_id", "product_id", "product_price_list_id", "settings"]}, "updateProductPriceListPriceInput": {"properties": {"currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency."}, "price": {"type": "number", "format": "double", "example": 4.32, "description": "Price amount stored at 6-decimal precision; values set via the API are rounded."}, "product_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product."}, "product_price_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the price list."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-price access controls (e.g. which user roles can override this price). Stored as a JSON object."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchProductPriceListPriceInput": {"properties": {"currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency."}, "price": {"type": "number", "format": "double", "example": 4.32, "description": "Price amount stored at 6-decimal precision; values set via the API are rounded."}, "product_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product."}, "product_price_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the price list."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-price access controls (e.g. which user roles can override this price). Stored as a JSON object."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ProductType": {"properties": {"has_draft": {"type": "boolean", "example": false, "description": "Set to True if draft for entity exists and can be published"}, "is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "form_edit_api": {"type": "object", "description": "API-friendly form definition. Returns the published form merged with any pending draft changes; read via this field, modify via the underlying form_edit / form_lost field through drafts."}, "can_change_readonly": {"type": "boolean", "example": false, "description": "Returns if user can change readonly flag on this entity_type."}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "oppty_product_relation_type": {"type": "string", "format": "uri", "description": "Opportunity / quote line-item type paired with this product type. Drives the form used when adding products of this type as line items.\n\nRelation to OpptyProductRelationType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelationType' object for properties."}, "form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing products of this type."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the product type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "oppty_product_relation_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the paired opportunity/quote line-item type."}, "is_published": {"type": "boolean", "example": false, "description": "True when the entity configuration is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["has_draft", "is_delete_protected", "form_edit_api", "id", "oppty_product_relation_type", "is_readonly", "name", "oppty_product_relation_type_id"]}, "createProductTypeInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing products of this type."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the product type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "is_published": {"type": "boolean", "example": false, "description": "True when the entity configuration is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_readonly", "name"]}, "updateProductTypeInput": {"properties": {"form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing products of this type."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the product type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchProductTypeInput": {"properties": {"form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing products of this type."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the product type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Profile": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "owner": {"type": "string", "format": "uri", "description": "User who owns the screen profile.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "sync_entity": {"type": "string", "format": "uri", "description": "Specific record this profile is synchronized to. Set only when sync_enabled is true.\n\nRelation to Report. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Report' object for properties."}, "entity": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Pipelinescreen, 2 - Timelinescreen, 3 - Archivescreen, 4 - Leadscreen, 6 - Accountscreen, 7 - Contactscreen, 8 - Activityscreen, 9 - Feedscreen, 10 - Hrmscreen, 11 - Auditscreen, 12 - Navigator, 13 - Insightsscreen, 14 - Indicatorsscreen, 15 - Conversionsscreen, 16 - Lifecyclescreen, 17 - Feedscreen2, 18 - ProductScreen, 19 - Projectscreen, 20 - Forecastscreen, 21 - LeadArchivescreen, 22 - TargetScreen, 23 - Quotescreen, 24 - QuoteArchivescreen, 25 - Approvalscreen, 26 - CustomEntityscreen, 27 - AccountArchivescreen, 28 - ContactArchivescreen, 29 - FeedDetailScreen, 30 - BetterNavigatorscreen, 31 - FeedEmailscreen, 32 - FeedEmailDetailScreen, 33 - EmailScreen", "example": 1, "enum": [1, 2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33]}, "entity_api_name": {"type": "string", "example": "string", "description": "API name of the custom entity this profile applies to. Set only when the profile targets a custom entity screen; otherwise empty."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "settings": {"type": "object", "description": "Layout and chart configuration of the screen profile, stored as a JSON document."}, "share_mode": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "sync_enabled": {"type": "boolean", "example": false, "description": "When true, changes to the profile are propagated to records linked via ProfileRelation; when false, the profile is detached from the records."}, "sync_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the synchronized record."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Dynamic, 2 - Static", "example": 1, "enum": [1, 2]}, "use_lang": {"type": "boolean", "example": false, "description": "When true, the profile name is treated as a translation key and localized in the UI; otherwise the literal name is shown."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "pipelines": {"type": "array", "items": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000"}, "description": "For pipeline-screen profiles, ids of the pipelines included in the profile configuration; empty for profiles on other screens."}}, "required": ["is_delete_protected", "id", "owner", "entity", "name", "owner_id", "settings", "pipelines"]}, "ProfileRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account": {"type": "string", "format": "uri", "description": "Account this profile is linked to, when applicable.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "contact": {"type": "string", "format": "uri", "description": "Contact this profile is linked to, when applicable.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "custom_entity": {"type": "string", "format": "uri", "description": "Custom entity record this profile is linked to, when applicable.\n\nRelation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties."}, "lead": {"type": "string", "format": "uri", "description": "Lead this profile is linked to. Set when lead_oppty_id resolves to a Lead.\n\nRelation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties."}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity this profile is linked to. Set when lead_oppty_id resolves to an Opportunity.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "profile": {"type": "string", "format": "uri", "description": "Screen profile this relation links to a specific record.\n\nRelation to Profile. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Profile' object for properties."}, "project": {"type": "string", "format": "uri", "description": "Project this profile is linked to, when applicable.\n\nRelation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties."}, "quote": {"type": "string", "format": "uri", "description": "Quote this profile is linked to, when applicable.\n\nRelation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity, or empty when not pointing to one."}, "profile_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the screen profile."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}}, "required": ["is_delete_protected", "id", "profile", "profile_id"]}, "createProfileRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity, or empty when not pointing to one."}, "profile_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the screen profile."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}}, "required": ["profile_id"]}, "updateProfileRelationInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity, or empty when not pointing to one."}, "profile_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the screen profile."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}}}, "batchProfileRelationInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead or opportunity, or empty when not pointing to one."}, "profile_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the screen profile."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ProfileSharingClientRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client": {"type": "string", "format": "uri", "description": "User granted shared access to the profile.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "profile": {"type": "string", "format": "uri", "description": "Screen profile being shared.\n\nRelation to Profile. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Profile' object for properties."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "profile_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared profile."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "client", "profile", "client_id", "profile_id"]}, "ProfileSharingSalesUnitRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "profile": {"type": "string", "format": "uri", "description": "Screen profile being shared.\n\nRelation to Profile. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Profile' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit granted shared access to the profile.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "profile_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared profile."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "profile", "unit", "profile_id", "unit_id"]}, "Project": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account": {"type": "string", "format": "uri", "description": "Account this project is delivered for, or empty for internal projects without an external account.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "currency_exchange_rates_list": {"type": "string", "format": "uri", "description": "Currency exchange rate list used to convert monetary fields linked to this project. Empty to inherit the team space default.\n\nRelation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRatesList' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "Sales user who owns this project.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "project_type": {"type": "string", "format": "uri", "description": "Project type that classifies this project. Project types are configurable per team space and drive which form, fields and objectives apply.\n\nRelation to ProjectType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProjectType' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit this project is assigned to. Determines which team members can see the record under unit-based sharing.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the related account."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this project."}, "description": {"type": "string", "example": "string", "description": "Free-form description of the project."}, "end_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Planned end date of the project. Must be on or after start_date when both are set."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project owner."}, "project_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project type."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users).\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when the project starts."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "revenue_goal": {"type": "object", "properties": {"base_value": {"type": "number", "format": "double", "example": "4.32", "description": "Currency."}, "currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "value_foreign": {"type": "number", "format": "double", "example": "4.32", "description": "Decimal number."}}, "required": ["base_value", "currency_id", "value_foreign"], "description": "Target revenue of the project, stored in the team space base currency with the foreign value and currency code preserved alongside."}, "documents": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties."}, "description": "Documents linked to this project."}, "sharing_units": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ProjectSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProjectSharingSalesUnitRelation' object for properties."}, "description": "Sales units that have been granted shared access to this project. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ProjectSharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProjectSharingClientRelation' object for properties."}, "description": "Users that have been granted shared access to this project. Editable only when share_mode allows user sharing."}, "primary_contact": {"type": "string", "format": "uri", "description": "Primary contact of this project. Set automatically from the contact relation marked as primary.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "contact_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ProjectContactRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProjectContactRelation' object for properties."}, "description": "Contacts linked to this project, including the primary-contact flag."}, "tags": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to TagRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TagRelation' object for properties."}, "description": "Tag labels applied to this project."}, "static_profiles": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ProfileRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProfileRelation' object for properties."}, "description": "Saved view profiles this project currently matches."}, "objectives": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ProjectObjective. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProjectObjective' object for properties."}, "description": "Objectives defined for this project, sorted by display order."}, "is_favorite": {"type": "boolean", "example": false, "description": "True when the current authenticated user has marked this project as favorite. Per-user."}, "status": {"type": "integer", "description": "Current status of the project (NotStarted, InProgress, Completed). Read-only; derived from is_completed and the underlying activity progress.\n\nInteger enum value: 1 - NotStarted, 2 - InProgress, 4 - Completed", "example": 1, "enum": [1, 2, 4]}, "completion_rate": {"type": "number", "format": "double", "example": "4.32", "description": "Percentage of activities (tasks and appointments) on this project that are completed. Read-only; computed by Coevera."}, "activities_total": {"type": "number", "format": "double", "example": "4.32", "description": "Total number of activities (tasks and appointments) linked to this project. Read-only; computed by Coevera."}, "activities_completed": {"type": "number", "format": "double", "example": "4.32", "description": "Number of completed activities on this project. Read-only; computed by Coevera."}, "formatted_name": {"type": "string", "example": "string", "description": "Display version of the project name, used in lists and references."}, "modified_by_user": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera."}}, "required": ["is_delete_protected", "id", "owner", "project_type", "unit", "end_date", "name", "owner_id", "revenue_goal", "is_favorite", "status", "formatted_name"]}, "createProjectInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the related account."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this project."}, "description": {"type": "string", "example": "string", "description": "Free-form description of the project."}, "end_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Planned end date of the project. Must be on or after start_date when both are set."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project owner."}, "project_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project type."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users).\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when the project starts."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "revenue_goal": {"type": "object", "properties": {"base_value": {"type": "number", "format": "double", "example": "4.32", "description": "Currency."}, "currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "value_foreign": {"type": "number", "format": "double", "example": "4.32", "description": "Decimal number."}}, "required": ["base_value", "currency_id", "value_foreign"], "description": "Target revenue of the project, stored in the team space base currency with the foreign value and currency code preserved alongside."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this project."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProjectSharingSalesUnitRelation, see: 'createProjectSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this project. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProjectSharingClientRelation, see: 'createProjectSharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this project. Editable only when share_mode allows user sharing."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProjectContactRelation, see: 'createProjectContactRelationInput' object for properties."}, "description": "Contacts linked to this project, including the primary-contact flag."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'createTagRelationInput' object for properties."}, "description": "Tag labels applied to this project."}, "static_profiles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProfileRelation, see: 'createProfileRelationInput' object for properties."}, "description": "Saved view profiles this project currently matches."}}, "required": ["end_date", "name", "owner_id", "revenue_goal"]}, "updateProjectInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the related account."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this project."}, "description": {"type": "string", "example": "string", "description": "Free-form description of the project."}, "end_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Planned end date of the project. Must be on or after start_date when both are set."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project owner."}, "project_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project type."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users).\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when the project starts."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "revenue_goal": {"type": "object", "properties": {"base_value": {"type": "number", "format": "double", "example": "4.32", "description": "Currency."}, "currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "value_foreign": {"type": "number", "format": "double", "example": "4.32", "description": "Decimal number."}}, "required": ["base_value", "currency_id", "value_foreign"], "description": "Target revenue of the project, stored in the team space base currency with the foreign value and currency code preserved alongside."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this project."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProjectSharingSalesUnitRelation, see: 'updateProjectSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this project. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProjectSharingClientRelation, see: 'updateProjectSharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this project. Editable only when share_mode allows user sharing."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProjectContactRelation, see: 'updateProjectContactRelationInput' object for properties."}, "description": "Contacts linked to this project, including the primary-contact flag."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'updateTagRelationInput' object for properties."}, "description": "Tag labels applied to this project."}, "static_profiles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProfileRelation, see: 'updateProfileRelationInput' object for properties."}, "description": "Saved view profiles this project currently matches."}}}, "batchProjectInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the related account."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this project."}, "description": {"type": "string", "example": "string", "description": "Free-form description of the project."}, "end_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Planned end date of the project. Must be on or after start_date when both are set."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project owner."}, "project_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project type."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users).\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when the project starts."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "revenue_goal": {"type": "object", "properties": {"base_value": {"type": "number", "format": "double", "example": "4.32", "description": "Currency."}, "currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "value_foreign": {"type": "number", "format": "double", "example": "4.32", "description": "Decimal number."}}, "required": ["base_value", "currency_id", "value_foreign"], "description": "Target revenue of the project, stored in the team space base currency with the foreign value and currency code preserved alongside."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this project."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProjectSharingSalesUnitRelation, see: 'updateProjectSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this project. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProjectSharingClientRelation, see: 'updateProjectSharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this project. Editable only when share_mode allows user sharing."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProjectContactRelation, see: 'updateProjectContactRelationInput' object for properties."}, "description": "Contacts linked to this project, including the primary-contact flag."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'updateTagRelationInput' object for properties."}, "description": "Tag labels applied to this project."}, "static_profiles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProfileRelation, see: 'updateProfileRelationInput' object for properties."}, "description": "Saved view profiles this project currently matches."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ProjectContactRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "contact": {"type": "string", "format": "uri", "description": "Contact linked to the project.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "project": {"type": "string", "format": "uri", "description": "Project the contact is linked to.\n\nRelation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "contact", "project", "contact_id", "is_primary", "project_id"]}, "createProjectContactRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["contact_id", "is_primary", "project_id"]}, "updateProjectContactRelationInput": {"properties": {"contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchProjectContactRelationInput": {"properties": {"contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ProjectDataExRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "data": {"type": "string", "format": "uri", "description": "External data record (Data entity) holding the enrichment payload.\n\nRelation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties."}, "project": {"type": "string", "format": "uri", "description": "Project this enrichment record applies to.\n\nRelation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties."}, "data_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the external data record."}, "data_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier of the data set the enrichment record originates from."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "data", "project", "data_id", "data_set_id", "project_id"]}, "ProjectKPI": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client": {"type": "string", "format": "uri", "description": "User who triggered the KPI event (project completion).\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "Project owner at the time the KPI event occurred.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "project": {"type": "string", "format": "uri", "description": "Project this KPI event relates to.\n\nRelation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit the triggering user belonged to at the time of the event.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration)."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who triggered the event."}, "kpi": {"type": "integer", "description": "KPI metric this event represents: ProjectCompleted.\n\nInteger enum value: 1 - ProjectCompleted", "example": 1, "enum": [1]}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project owner at the time of the event."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "owner", "project", "kpi", "owner_id", "project_id"]}, "createProjectKPIInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration)."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who triggered the event."}, "kpi": {"type": "integer", "description": "KPI metric this event represents: ProjectCompleted.\n\nInteger enum value: 1 - ProjectCompleted", "example": 1, "enum": [1]}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project owner at the time of the event."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["kpi", "owner_id", "project_id"]}, "updateProjectKPIInput": {"properties": {"application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration)."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who triggered the event."}, "kpi": {"type": "integer", "description": "KPI metric this event represents: ProjectCompleted.\n\nInteger enum value: 1 - ProjectCompleted", "example": 1, "enum": [1]}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project owner at the time of the event."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchProjectKPIInput": {"properties": {"application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration)."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who triggered the event."}, "kpi": {"type": "integer", "description": "KPI metric this event represents: ProjectCompleted.\n\nInteger enum value: 1 - ProjectCompleted", "example": 1, "enum": [1]}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project owner at the time of the event."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ProjectObjective": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "project": {"type": "string", "format": "uri", "description": "Project this objective belongs to.\n\nRelation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project.", "readOnly": true}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the row within its sibling set; lower values appear first. The platform reorders neighbouring rows automatically when a value is inserted or changed."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "project", "name", "project_id", "sort_order"]}, "createProjectObjectiveInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project.", "readOnly": true}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the row within its sibling set; lower values appear first. The platform reorders neighbouring rows automatically when a value is inserted or changed."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["name", "project_id", "sort_order"]}, "updateProjectObjectiveInput": {"properties": {"name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the row within its sibling set; lower values appear first. The platform reorders neighbouring rows automatically when a value is inserted or changed."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchProjectObjectiveInput": {"properties": {"name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the row within its sibling set; lower values appear first. The platform reorders neighbouring rows automatically when a value is inserted or changed."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ProjectSharingClientRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client": {"type": "string", "format": "uri", "description": "User the project is shared with.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "project": {"type": "string", "format": "uri", "description": "Project being shared.\n\nRelation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared project."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the project.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "client", "project", "client_id", "project_id"]}, "createProjectSharingClientRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared project."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the project.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["client_id", "project_id"]}, "updateProjectSharingClientRelationInput": {"properties": {"client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared project."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the project.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchProjectSharingClientRelationInput": {"properties": {"client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared project."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the project.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ProjectSharingSalesUnitRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "project": {"type": "string", "format": "uri", "description": "Project being shared.\n\nRelation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit the project is shared with.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared project."}, "role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the project.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "project", "unit", "project_id", "unit_id"]}, "createProjectSharingSalesUnitRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared project."}, "role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the project.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["project_id", "unit_id"]}, "updateProjectSharingSalesUnitRelationInput": {"properties": {"project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared project."}, "role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the project.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchProjectSharingSalesUnitRelationInput": {"properties": {"project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared project."}, "role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the project.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ProjectType": {"properties": {"has_draft": {"type": "boolean", "example": false, "description": "Set to True if draft for entity exists and can be published"}, "is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "form_edit_api": {"type": "object", "description": "API-friendly form definition. Returns the published form merged with any pending draft changes; read via this field, modify via the underlying form_edit / form_lost field through drafts."}, "can_change_readonly": {"type": "boolean", "example": false, "description": "Returns if user can change readonly flag on this entity_type."}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing projects of this type."}, "icon": {"type": "integer", "description": "Icon used to display projects of this type in the UI (e.g. GeneralIcon, Account).\n\nInteger enum value: 0 - GeneralIcon, 1 - Account", "example": 0, "enum": [0, 1]}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the project type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "is_published": {"type": "boolean", "example": false, "description": "True when the entity configuration is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["has_draft", "is_delete_protected", "form_edit_api", "id", "is_readonly", "name", "settings"]}, "createProjectTypeInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing projects of this type."}, "icon": {"type": "integer", "description": "Icon used to display projects of this type in the UI (e.g. GeneralIcon, Account).\n\nInteger enum value: 0 - GeneralIcon, 1 - Account", "example": 0, "enum": [0, 1]}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the project type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "is_published": {"type": "boolean", "example": false, "description": "True when the entity configuration is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_readonly", "name", "settings"]}, "updateProjectTypeInput": {"properties": {"form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing projects of this type."}, "icon": {"type": "integer", "description": "Icon used to display projects of this type in the UI (e.g. GeneralIcon, Account).\n\nInteger enum value: 0 - GeneralIcon, 1 - Account", "example": 0, "enum": [0, 1]}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the project type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchProjectTypeInput": {"properties": {"form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing projects of this type."}, "icon": {"type": "integer", "description": "Icon used to display projects of this type in the UI (e.g. GeneralIcon, Account).\n\nInteger enum value: 0 - GeneralIcon, 1 - Account", "example": 0, "enum": [0, 1]}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the project type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Quote": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "currency_exchange_rates_list": {"type": "string", "format": "uri", "description": "Currency exchange rate list used to convert monetary fields linked to this quote. Empty to inherit the team space default.\n\nRelation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRatesList' object for properties."}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity this quote was prepared for. Empty for standalone quotes.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "Sales user who owns this quote.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "product_currency": {"type": "string", "format": "uri", "description": "Currency used for product line-item prices on this quote.\n\nRelation to Currency. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Currency' object for properties."}, "product_price_list": {"type": "string", "format": "uri", "description": "Product price list used to populate prices for product line items added to this quote. Empty to use catalog defaults.\n\nRelation to ProductPriceList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProductPriceList' object for properties."}, "quote_type": {"type": "string", "format": "uri", "description": "Quote type that classifies this quote. Each type maps to one quote process and drives which form, fields and stages apply.\n\nRelation to QuoteType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'QuoteType' object for properties."}, "reason_of_close": {"type": "string", "format": "uri", "description": "Configurable reason recorded when the quote is archived (lost). Required when the lost form mandates it.\n\nRelation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties."}, "step": {"type": "string", "format": "uri", "description": "Quote-process step the quote is currently sitting in. Reaching the last step in the process marks the quote as accepted.\n\nRelation to Step. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Step' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit this quote is assigned to. Determines which team members can see the record under unit-based sharing.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this quote."}, "description": {"type": "string", "example": "string", "description": "Free-form description of the quote."}, "expiration_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date after which the quote is no longer considered valid."}, "is_archived": {"type": "boolean", "example": false, "description": "True when the quote has been archived (lost). Archived quotes remain readable but are hidden from active lists and cannot be edited until reactivated."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote owner."}, "product_currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product currency."}, "product_price_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product price list."}, "product_sections": {"type": "object", "description": "Product sections grouping the record's line items, as a JSON array of {\"id\": <UUID>, \"name\": <string>} objects. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/productsection.doc.html"}, "quick_account_email": {"type": "string", "example": "string", "description": "Free-text company email captured at quote creation when no Account record has been linked yet."}, "quick_account_name": {"type": "string", "example": "string", "description": "Free-text company name captured at quote creation when no Account record has been linked yet."}, "quick_account_phone": {"type": "string", "example": "string", "description": "Free-text company phone captured at quote creation when no Account record has been linked yet."}, "quick_contact_name": {"type": "string", "example": "string", "description": "Free-text contact name captured at quote creation when no Contact record has been linked yet."}, "quick_email": {"type": "string", "example": "string", "description": "Free-text contact email captured at quote creation when no Contact record has been linked yet."}, "quick_phone": {"type": "string", "example": "string", "description": "Free-text contact phone captured at quote creation when no Contact record has been linked yet."}, "quote_number": {"type": "string", "example": "string", "description": "Auto-generated sequential identifier of the quote, used for human-readable reference.", "readOnly": true}, "quote_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote type."}, "reason_of_close_description": {"type": "string", "example": "string", "description": "Free-form note explaining why the quote was archived (lost)."}, "reason_of_close_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the reason-of-close value."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "step_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote-process step."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "version": {"type": "integer", "format": "int32", "example": 1, "description": "Revision number of the quote, incremented when a new version of the same quote is created."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "total_amount": {"type": "object", "properties": {"base_value": {"type": "number", "format": "double", "example": "4.32", "description": "Currency."}, "currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "value_foreign": {"type": "number", "format": "double", "example": "4.32", "description": "Decimal number."}}, "required": ["base_value", "currency_id", "value_foreign"], "description": "Total monetary value of the quote in the team space base currency, with the foreign value and currency code preserved alongside."}, "product_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to OpptyProductRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelation' object for properties."}, "description": "Product line items on this quote. Each entry holds the product, quantity, price and discount that contribute to total_amount."}, "primary_contact": {"type": "string", "format": "uri", "description": "Primary contact of this quote. Set automatically from the contact relation marked as primary.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "primary_account": {"type": "string", "format": "uri", "description": "Primary account of this quote. Set automatically from the account relation marked as primary.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "contact_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to QuoteContactRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'QuoteContactRelation' object for properties."}, "description": "Contacts linked to this quote."}, "account_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to QuoteAccountRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'QuoteAccountRelation' object for properties."}, "description": "Accounts linked to this quote, including the primary-account flag."}, "documents": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties."}, "description": "Documents linked to this quote."}, "sharing_units": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to QuoteSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'QuoteSharingSalesUnitRelation' object for properties."}, "description": "Sales units that have been granted shared access to this quote. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to QuoteSharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'QuoteSharingClientRelation' object for properties."}, "description": "Users that have been granted shared access to this quote. Editable only when share_mode allows user sharing."}, "status": {"type": "integer", "description": "Current status of the quote (Open, Lost, Accepted). Read-only; derived from the current step and the archived flag.\n\nInteger enum value: 1 - Open, 2 - Lost, 3 - Accepted", "example": 1, "enum": [1, 2, 3], "readOnly": true}, "formatted_name": {"type": "string", "example": "string", "description": "Display version of the quote name, used in lists and references."}, "is_favorite": {"type": "boolean", "example": false, "description": "True when the current authenticated user has marked this quote as favorite. Per-user."}, "is_active_in_opportunity": {"type": "boolean", "example": false, "description": "If quote is set as active in opportunity."}, "modified_by_user": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera."}, "static_profiles": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ProfileRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProfileRelation' object for properties."}, "description": "Saved view profiles this quote currently matches."}, "tags": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to TagRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TagRelation' object for properties."}, "description": "Tag labels applied to this quote."}}, "required": ["is_delete_protected", "id", "owner", "product_currency", "quote_type", "step", "unit", "name", "owner_id", "step_id", "total_amount", "status", "formatted_name", "is_favorite"]}, "createQuoteInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this quote."}, "description": {"type": "string", "example": "string", "description": "Free-form description of the quote."}, "expiration_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date after which the quote is no longer considered valid."}, "is_archived": {"type": "boolean", "example": false, "description": "True when the quote has been archived (lost). Archived quotes remain readable but are hidden from active lists and cannot be edited until reactivated."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote owner."}, "product_currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product currency."}, "product_price_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product price list."}, "product_sections": {"type": "object", "description": "Product sections grouping the record's line items, as a JSON array of {\"id\": <UUID>, \"name\": <string>} objects. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/productsection.doc.html"}, "quick_account_email": {"type": "string", "example": "string", "description": "Free-text company email captured at quote creation when no Account record has been linked yet."}, "quick_account_name": {"type": "string", "example": "string", "description": "Free-text company name captured at quote creation when no Account record has been linked yet."}, "quick_account_phone": {"type": "string", "example": "string", "description": "Free-text company phone captured at quote creation when no Account record has been linked yet."}, "quick_contact_name": {"type": "string", "example": "string", "description": "Free-text contact name captured at quote creation when no Contact record has been linked yet."}, "quick_email": {"type": "string", "example": "string", "description": "Free-text contact email captured at quote creation when no Contact record has been linked yet."}, "quick_phone": {"type": "string", "example": "string", "description": "Free-text contact phone captured at quote creation when no Contact record has been linked yet."}, "quote_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote type."}, "reason_of_close_description": {"type": "string", "example": "string", "description": "Free-form note explaining why the quote was archived (lost)."}, "reason_of_close_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the reason-of-close value."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "step_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote-process step."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "version": {"type": "integer", "format": "int32", "example": 1, "description": "Revision number of the quote, incremented when a new version of the same quote is created."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "total_amount": {"type": "object", "properties": {"base_value": {"type": "number", "format": "double", "example": "4.32", "description": "Currency."}, "currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "value_foreign": {"type": "number", "format": "double", "example": "4.32", "description": "Decimal number."}}, "required": ["base_value", "currency_id", "value_foreign"], "description": "Total monetary value of the quote in the team space base currency, with the foreign value and currency code preserved alongside."}, "product_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OpptyProductRelation, see: 'createOpptyProductRelationInput' object for properties."}, "description": "Product line items on this quote. Each entry holds the product, quantity, price and discount that contribute to total_amount."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to QuoteContactRelation, see: 'createQuoteContactRelationInput' object for properties."}, "description": "Contacts linked to this quote."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to QuoteAccountRelation, see: 'createQuoteAccountRelationInput' object for properties."}, "description": "Accounts linked to this quote, including the primary-account flag."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this quote."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to QuoteSharingSalesUnitRelation, see: 'createQuoteSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this quote. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to QuoteSharingClientRelation, see: 'createQuoteSharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this quote. Editable only when share_mode allows user sharing."}, "is_active_in_opportunity": {"type": "boolean", "example": false, "description": "If quote is set as active in opportunity."}, "static_profiles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProfileRelation, see: 'createProfileRelationInput' object for properties."}, "description": "Saved view profiles this quote currently matches."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'createTagRelationInput' object for properties."}, "description": "Tag labels applied to this quote."}}, "required": ["name", "owner_id", "step_id", "total_amount"]}, "updateQuoteInput": {"properties": {"currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this quote."}, "description": {"type": "string", "example": "string", "description": "Free-form description of the quote."}, "expiration_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date after which the quote is no longer considered valid."}, "is_archived": {"type": "boolean", "example": false, "description": "True when the quote has been archived (lost). Archived quotes remain readable but are hidden from active lists and cannot be edited until reactivated."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote owner."}, "product_currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product currency."}, "product_price_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product price list."}, "product_sections": {"type": "object", "description": "Product sections grouping the record's line items, as a JSON array of {\"id\": <UUID>, \"name\": <string>} objects. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/productsection.doc.html"}, "quick_account_email": {"type": "string", "example": "string", "description": "Free-text company email captured at quote creation when no Account record has been linked yet."}, "quick_account_name": {"type": "string", "example": "string", "description": "Free-text company name captured at quote creation when no Account record has been linked yet."}, "quick_account_phone": {"type": "string", "example": "string", "description": "Free-text company phone captured at quote creation when no Account record has been linked yet."}, "quick_contact_name": {"type": "string", "example": "string", "description": "Free-text contact name captured at quote creation when no Contact record has been linked yet."}, "quick_email": {"type": "string", "example": "string", "description": "Free-text contact email captured at quote creation when no Contact record has been linked yet."}, "quick_phone": {"type": "string", "example": "string", "description": "Free-text contact phone captured at quote creation when no Contact record has been linked yet."}, "quote_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote type."}, "reason_of_close_description": {"type": "string", "example": "string", "description": "Free-form note explaining why the quote was archived (lost)."}, "reason_of_close_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the reason-of-close value."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "step_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote-process step."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "version": {"type": "integer", "format": "int32", "example": 1, "description": "Revision number of the quote, incremented when a new version of the same quote is created."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "total_amount": {"type": "object", "properties": {"base_value": {"type": "number", "format": "double", "example": "4.32", "description": "Currency."}, "currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "value_foreign": {"type": "number", "format": "double", "example": "4.32", "description": "Decimal number."}}, "required": ["base_value", "currency_id", "value_foreign"], "description": "Total monetary value of the quote in the team space base currency, with the foreign value and currency code preserved alongside."}, "product_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OpptyProductRelation, see: 'updateOpptyProductRelationInput' object for properties."}, "description": "Product line items on this quote. Each entry holds the product, quantity, price and discount that contribute to total_amount."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to QuoteContactRelation, see: 'updateQuoteContactRelationInput' object for properties."}, "description": "Contacts linked to this quote."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to QuoteAccountRelation, see: 'updateQuoteAccountRelationInput' object for properties."}, "description": "Accounts linked to this quote, including the primary-account flag."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this quote."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to QuoteSharingSalesUnitRelation, see: 'updateQuoteSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this quote. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to QuoteSharingClientRelation, see: 'updateQuoteSharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this quote. Editable only when share_mode allows user sharing."}, "is_active_in_opportunity": {"type": "boolean", "example": false, "description": "If quote is set as active in opportunity."}, "static_profiles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProfileRelation, see: 'updateProfileRelationInput' object for properties."}, "description": "Saved view profiles this quote currently matches."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'updateTagRelationInput' object for properties."}, "description": "Tag labels applied to this quote."}}}, "batchQuoteInput": {"properties": {"currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this quote."}, "description": {"type": "string", "example": "string", "description": "Free-form description of the quote."}, "expiration_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date after which the quote is no longer considered valid."}, "is_archived": {"type": "boolean", "example": false, "description": "True when the quote has been archived (lost). Archived quotes remain readable but are hidden from active lists and cannot be edited until reactivated."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote owner."}, "product_currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product currency."}, "product_price_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product price list."}, "product_sections": {"type": "object", "description": "Product sections grouping the record's line items, as a JSON array of {\"id\": <UUID>, \"name\": <string>} objects. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/productsection.doc.html"}, "quick_account_email": {"type": "string", "example": "string", "description": "Free-text company email captured at quote creation when no Account record has been linked yet."}, "quick_account_name": {"type": "string", "example": "string", "description": "Free-text company name captured at quote creation when no Account record has been linked yet."}, "quick_account_phone": {"type": "string", "example": "string", "description": "Free-text company phone captured at quote creation when no Account record has been linked yet."}, "quick_contact_name": {"type": "string", "example": "string", "description": "Free-text contact name captured at quote creation when no Contact record has been linked yet."}, "quick_email": {"type": "string", "example": "string", "description": "Free-text contact email captured at quote creation when no Contact record has been linked yet."}, "quick_phone": {"type": "string", "example": "string", "description": "Free-text contact phone captured at quote creation when no Contact record has been linked yet."}, "quote_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote type."}, "reason_of_close_description": {"type": "string", "example": "string", "description": "Free-form note explaining why the quote was archived (lost)."}, "reason_of_close_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the reason-of-close value."}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "step_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote-process step."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "version": {"type": "integer", "format": "int32", "example": 1, "description": "Revision number of the quote, incremented when a new version of the same quote is created."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "total_amount": {"type": "object", "properties": {"base_value": {"type": "number", "format": "double", "example": "4.32", "description": "Currency."}, "currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Relation to single entity instance."}, "value_foreign": {"type": "number", "format": "double", "example": "4.32", "description": "Decimal number."}}, "required": ["base_value", "currency_id", "value_foreign"], "description": "Total monetary value of the quote in the team space base currency, with the foreign value and currency code preserved alongside."}, "product_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to OpptyProductRelation, see: 'updateOpptyProductRelationInput' object for properties."}, "description": "Product line items on this quote. Each entry holds the product, quantity, price and discount that contribute to total_amount."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to QuoteContactRelation, see: 'updateQuoteContactRelationInput' object for properties."}, "description": "Contacts linked to this quote."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to QuoteAccountRelation, see: 'updateQuoteAccountRelationInput' object for properties."}, "description": "Accounts linked to this quote, including the primary-account flag."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this quote."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to QuoteSharingSalesUnitRelation, see: 'updateQuoteSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this quote. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to QuoteSharingClientRelation, see: 'updateQuoteSharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this quote. Editable only when share_mode allows user sharing."}, "is_active_in_opportunity": {"type": "boolean", "example": false, "description": "If quote is set as active in opportunity."}, "static_profiles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ProfileRelation, see: 'updateProfileRelationInput' object for properties."}, "description": "Saved view profiles this quote currently matches."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'updateTagRelationInput' object for properties."}, "description": "Tag labels applied to this quote."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "QuoteAccountRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account": {"type": "string", "format": "uri", "description": "Account linked to the quote.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "quote": {"type": "string", "format": "uri", "description": "Quote the account is linked to.\n\nRelation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "account", "quote", "account_id", "is_primary", "quote_id"]}, "createQuoteAccountRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["account_id", "is_primary", "quote_id"]}, "updateQuoteAccountRelationInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchQuoteAccountRelationInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "QuoteContactRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "contact": {"type": "string", "format": "uri", "description": "Contact linked to the quote.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "quote": {"type": "string", "format": "uri", "description": "Quote the contact is linked to.\n\nRelation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "contact", "quote", "contact_id", "is_primary", "quote_id"]}, "createQuoteContactRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["contact_id", "is_primary", "quote_id"]}, "updateQuoteContactRelationInput": {"properties": {"contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchQuoteContactRelationInput": {"properties": {"contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact."}, "is_primary": {"type": "boolean", "example": false, "description": "True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "QuoteDataExRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "data": {"type": "string", "format": "uri", "description": "Data record holding the additional fields linked to this quote.\n\nRelation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties."}, "quote": {"type": "string", "format": "uri", "description": "Quote this data relation row applies to.\n\nRelation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties."}, "data_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked data record."}, "data_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier of the data set the linked fields belong to."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "data", "quote", "data_id", "data_set_id", "quote_id"]}, "createQuoteDataExRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "data_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked data record."}, "data_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier of the data set the linked fields belong to."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["data_id", "data_set_id", "quote_id"]}, "updateQuoteDataExRelationInput": {"properties": {"data_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked data record."}, "data_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier of the data set the linked fields belong to."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchQuoteDataExRelationInput": {"properties": {"data_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked data record."}, "data_set_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Identifier of the data set the linked fields belong to."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "QuoteKPI": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client": {"type": "string", "format": "uri", "description": "User who triggered the KPI event (e.g. created the quote, accepted it, archived it, moved the record).\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "Quote owner at the time the KPI event occurred.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "quote": {"type": "string", "format": "uri", "description": "Quote this KPI event relates to.\n\nRelation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit the triggering user belonged to at the time of the event.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration)."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who triggered the event."}, "kpi": {"type": "integer", "description": "KPI metric this event represents: Create, Accept, Archive, LastMove.\n\nInteger enum value: 1 - Create, 2 - Accept, 3 - Archive, 4 - LastMove", "example": 1, "enum": [1, 2, 3, 4]}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote owner at the time of the event."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "owner", "quote", "kpi", "owner_id", "quote_id"]}, "createQuoteKPIInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration)."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who triggered the event."}, "kpi": {"type": "integer", "description": "KPI metric this event represents: Create, Accept, Archive, LastMove.\n\nInteger enum value: 1 - Create, 2 - Accept, 3 - Archive, 4 - LastMove", "example": 1, "enum": [1, 2, 3, 4]}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote owner at the time of the event."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["kpi", "owner_id", "quote_id"]}, "updateQuoteKPIInput": {"properties": {"application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration)."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who triggered the event."}, "kpi": {"type": "integer", "description": "KPI metric this event represents: Create, Accept, Archive, LastMove.\n\nInteger enum value: 1 - Create, 2 - Accept, 3 - Archive, 4 - LastMove", "example": 1, "enum": [1, 2, 3, 4]}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote owner at the time of the event."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchQuoteKPIInput": {"properties": {"application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration)."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who triggered the event."}, "kpi": {"type": "integer", "description": "KPI metric this event represents: Create, Accept, Archive, LastMove.\n\nInteger enum value: 1 - Create, 2 - Accept, 3 - Archive, 4 - LastMove", "example": 1, "enum": [1, 2, 3, 4]}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote owner at the time of the event."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "QuoteProcess": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the quote process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "steps": {"type": "array", "items": {"$ref": "#/components/schemas/batchStepInput"}, "description": "Steps that make up this quote process, in evaluation order."}, "quote_types": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to QuoteType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'QuoteType' object for properties."}, "description": "Quote types that follow this quote process."}}, "required": ["is_delete_protected", "id", "name", "steps", "quote_types"]}, "createQuoteProcessInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the quote process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "steps": {"type": "array", "items": {"$ref": "#/components/schemas/batchStepInput"}, "description": "Steps that make up this quote process, in evaluation order."}}, "required": ["name", "steps"]}, "updateQuoteProcessInput": {"properties": {"color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the quote process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "steps": {"type": "array", "items": {"$ref": "#/components/schemas/batchStepInput"}, "description": "Steps that make up this quote process, in evaluation order."}}}, "batchQuoteProcessInput": {"properties": {"color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the quote process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "steps": {"type": "array", "items": {"$ref": "#/components/schemas/batchStepInput"}, "description": "Steps that make up this quote process, in evaluation order."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "QuoteSharingClientRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client": {"type": "string", "format": "uri", "description": "User the quote is shared with.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "quote": {"type": "string", "format": "uri", "description": "Quote being shared.\n\nRelation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared quote."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the quote.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "client", "quote", "client_id", "quote_id"]}, "createQuoteSharingClientRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared quote."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the quote.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["client_id", "quote_id"]}, "updateQuoteSharingClientRelationInput": {"properties": {"client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared quote."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the quote.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchQuoteSharingClientRelationInput": {"properties": {"client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared quote."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the quote.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "QuoteSharingSalesUnitRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "quote": {"type": "string", "format": "uri", "description": "Quote being shared.\n\nRelation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit the quote is shared with.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared quote."}, "role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the quote.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "quote", "unit", "quote_id", "unit_id"]}, "createQuoteSharingSalesUnitRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared quote."}, "role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the quote.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["quote_id", "unit_id"]}, "updateQuoteSharingSalesUnitRelationInput": {"properties": {"quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared quote."}, "role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the quote.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchQuoteSharingSalesUnitRelationInput": {"properties": {"quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared quote."}, "role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the quote.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "QuoteType": {"properties": {"has_draft": {"type": "boolean", "example": false, "description": "Set to True if draft for entity exists and can be published"}, "is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "form_edit_api": {"type": "object", "description": "API-friendly form definition. Returns the published form merged with any pending draft changes; read via this field, modify via the underlying form_edit / form_lost field through drafts."}, "can_change_readonly": {"type": "boolean", "example": false, "description": "Returns if user can change readonly flag on this entity_type."}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "quote_process": {"type": "string", "format": "uri", "description": "Quote process (pipeline) this quote type follows.\n\nRelation to QuoteProcess. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'QuoteProcess' object for properties."}, "form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing quotes of this type."}, "form_lost": {"type": "object", "description": "JSON definition of the form shown when archiving (losing) a quote of this type."}, "form_lost_enabled": {"type": "boolean", "example": false, "description": "True when the lost form is required on archiving quotes of this type."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the quote type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "quote_process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote process."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "is_published": {"type": "boolean", "example": false, "description": "True when the entity configuration is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "form_lost_api": {"type": "object", "description": "API-friendly form definition. Returns the published form merged with any pending draft changes; read via this field, modify via the underlying form_edit / form_lost field through drafts."}}, "required": ["has_draft", "is_delete_protected", "form_edit_api", "id", "quote_process", "form_lost_enabled", "is_readonly", "name", "quote_process_id", "settings", "form_lost_api"]}, "createQuoteTypeInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing quotes of this type."}, "form_lost": {"type": "object", "description": "JSON definition of the form shown when archiving (losing) a quote of this type."}, "form_lost_enabled": {"type": "boolean", "example": false, "description": "True when the lost form is required on archiving quotes of this type."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the quote type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "quote_process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote process."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "is_published": {"type": "boolean", "example": false, "description": "True when the entity configuration is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["form_lost_enabled", "is_readonly", "name", "quote_process_id", "settings"]}, "updateQuoteTypeInput": {"properties": {"form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing quotes of this type."}, "form_lost": {"type": "object", "description": "JSON definition of the form shown when archiving (losing) a quote of this type."}, "form_lost_enabled": {"type": "boolean", "example": false, "description": "True when the lost form is required on archiving quotes of this type."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the quote type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "quote_process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote process."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchQuoteTypeInput": {"properties": {"form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing quotes of this type."}, "form_lost": {"type": "object", "description": "JSON definition of the form shown when archiving (losing) a quote of this type."}, "form_lost_enabled": {"type": "boolean", "example": false, "description": "True when the lost form is required on archiving quotes of this type."}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the quote type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "quote_process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote process."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Report": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "owner": {"type": "string", "format": "uri", "description": "User who owns the report or dashboard.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "reports_folder": {"type": "string", "format": "uri", "description": "Report folder this report is filed under (default folder when empty).\n\nRelation to ReportFolder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ReportFolder' object for properties."}, "sync_entity": {"type": "string", "format": "uri", "description": "Specific record this report is synchronized to. Set only when sync_enabled is true.\n\nRelation to Profile. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Profile' object for properties."}, "access_link": {"type": "string", "example": "string", "description": "Public access token used in shareable report URLs. Empty when public sharing is not configured for the report."}, "ai_conversation": {"type": "object", "description": "AI assistant conversation associated with the report (e.g. records of AI-driven report generation)."}, "description": {"type": "string", "example": "string", "description": "Free-text description shown alongside the report."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "reports_folder_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent report folder."}, "settings": {"type": "object", "description": "Report definition (entity, columns, filters, charts, structure). Stored as a JSON document."}, "share_mode": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "share_mode_params": {"type": "string", "example": 1, "enum": [1, 2], "description": "Bit flags fine-tuning sharing behavior (e.g. allow editing for shared users)."}, "sync_enabled": {"type": "boolean", "example": false, "description": "When true, name and settings are kept in sync with the linked screen profile; when false, the report is detached from profile sync."}, "sync_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the synchronized record."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - TableReport, 1 - DashboardReport, 2 - ForecastReport, 3 - AdvancedReport", "example": 0, "enum": [0, 1, 2, 3]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "schedule": {"type": "string", "format": "uri", "description": "Scheduled-delivery configuration for this report. Empty when no schedule is set; modified via set_schedule / remove_schedule mutations.\n\nRelation to ReportSchedule. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ReportSchedule' object for properties."}, "is_favorite": {"type": "boolean", "example": false, "description": "True when the current user has marked this report as a favorite (see ClientFavorite)."}, "sharing_units": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ReportSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ReportSharingSalesUnitRelation' object for properties."}, "description": "Sales units granted shared access to this report (custom share mode)."}, "sharing_clients": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ReportSharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ReportSharingClientRelation' object for properties."}, "description": "Users granted shared access to this report (custom share mode)."}}, "required": ["is_delete_protected", "id", "owner", "reports_folder", "name", "owner_id", "reports_folder_id", "settings", "type", "is_favorite"]}, "ReportFolder": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "parent_report_folder": {"type": "string", "format": "uri", "description": "Parent report folder, when this folder is nested. Empty for top-level folders.\n\nRelation to ReportFolder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ReportFolder' object for properties."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "parent_report_folder_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent folder, or empty for top-level folders."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "name"]}, "ReportSchedule": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "owner": {"type": "string", "format": "uri", "description": "User who owns the schedule. The schedule sends emails on behalf of this user.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "report": {"type": "string", "format": "uri", "description": "Report whose delivery is scheduled.\n\nRelation to Report. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Report' object for properties."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "report_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the scheduled report."}, "settings": {"type": "object", "description": "Schedule configuration: cadence, timezone, recipients, email body and report attachment options. Stored as a JSON document."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "documents": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties."}, "description": "Files attached to scheduled emails sent for this report."}, "sender_email": {"type": "string", "example": "string", "description": "Email address used to send the scheduled report (company email when configured, otherwise the owner's personal email)."}, "report_name": {"type": "string", "example": "string", "description": "Name of the scheduled report (mirror of the linked Report.name)."}, "report_owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who owns the scheduled report."}, "report_type": {"type": "integer", "description": "Kind of the scheduled report (e.g. TableReport, AdvancedReport, DashboardReport).\n\nInteger enum value: 0 - TableReport, 1 - DashboardReport, 2 - ForecastReport, 3 - AdvancedReport", "example": 0, "enum": [0, 1, 2, 3]}}, "required": ["is_delete_protected", "id", "owner", "report", "owner_id", "report_id", "settings", "report_name", "report_owner_id", "report_type"]}, "createReportScheduleInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "report_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the scheduled report."}, "settings": {"type": "object", "description": "Schedule configuration: cadence, timezone, recipients, email body and report attachment options. Stored as a JSON document."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties."}, "description": "Files attached to scheduled emails sent for this report."}}, "required": ["owner_id", "report_id", "settings"]}, "updateReportScheduleInput": {"properties": {"owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "report_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the scheduled report."}, "settings": {"type": "object", "description": "Schedule configuration: cadence, timezone, recipients, email body and report attachment options. Stored as a JSON document."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Files attached to scheduled emails sent for this report."}}}, "batchReportScheduleInput": {"properties": {"owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "report_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the scheduled report."}, "settings": {"type": "object", "description": "Schedule configuration: cadence, timezone, recipients, email body and report attachment options. Stored as a JSON document."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Files attached to scheduled emails sent for this report."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "ReportSharingClientRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client": {"type": "string", "format": "uri", "description": "User granted shared access to the report.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "report": {"type": "string", "format": "uri", "description": "Report being shared.\n\nRelation to Report. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Report' object for properties."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "report_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared report."}, "role": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "client", "report", "client_id", "report_id"]}, "ReportSharingSalesUnitRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "report": {"type": "string", "format": "uri", "description": "Report being shared.\n\nRelation to Report. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Report' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit granted shared access to the report.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "report_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared report."}, "role": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "report", "unit", "report_id", "unit_id"]}, "SalesRole": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "color_code": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the sales role, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "color_code", "name"]}, "createSalesRoleInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "color_code": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the sales role, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["color_code", "name"]}, "updateSalesRoleInput": {"properties": {"color_code": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the sales role, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchSalesRoleInput": {"properties": {"color_code": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the sales role, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "SalesUnit": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "parent": {"type": "string", "format": "uri", "description": "Parent sales unit, when this unit is nested. Empty for the root unit.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "picture": {"type": "string", "format": "uri", "description": "Profile picture (logo) of the sales unit.\n\nRelation to CloudObject. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObject' object for properties."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "parent_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent unit, or empty for the root unit."}, "picture_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the picture cloud object."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "name"]}, "createSalesUnitInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "picture": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Profile picture (logo) of the sales unit.\n\nRelation to CloudObject, see: 'createCloudObjectInput' object for properties."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "parent_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent unit, or empty for the root unit."}, "picture_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the picture cloud object."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["name"]}, "updateSalesUnitInput": {"properties": {"picture": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Profile picture (logo) of the sales unit.\n\nRelation to CloudObject, see: 'updateCloudObjectInput' object for properties."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "parent_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent unit, or empty for the root unit."}, "picture_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the picture cloud object."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchSalesUnitInput": {"properties": {"picture": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Profile picture (logo) of the sales unit.\n\nRelation to CloudObject, see: 'updateCloudObjectInput' object for properties."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "parent_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent unit, or empty for the root unit."}, "picture_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the picture cloud object."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "SalesUnitClientRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client": {"type": "string", "format": "uri", "description": "User belonging to the sales unit.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit the user belongs to.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "unit_role": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Member, 2 - Manager", "example": 1, "enum": [1, 2]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "client", "unit", "client_id", "unit_id"]}, "Step": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "lead_process": {"type": "string", "format": "uri", "description": "Lead process this step belongs to. Set when the step is part of a lead process.\n\nRelation to LeadProcess. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadProcess' object for properties."}, "pipeline": {"type": "string", "format": "uri", "description": "Opportunity pipeline this step belongs to. Set when the step is part of an opportunity pipeline.\n\nRelation to Pipeline. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Pipeline' object for properties.", "readOnly": true}, "quote_process": {"type": "string", "format": "uri", "description": "Quote process this step belongs to. Set when the step is part of a quote process.\n\nRelation to QuoteProcess. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'QuoteProcess' object for properties."}, "description": {"type": "string", "example": "string", "description": "Free-text description shown in the step UI."}, "has_readonly_form": {"type": "boolean", "example": false, "description": "When true, the record form is read-only while a record is in this step."}, "has_version_increment": {"type": "boolean", "example": false, "description": "When true, transitioning a record into this step bumps its version counter."}, "lead_process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead process."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "percent": {"type": "integer", "format": "int32", "example": 1, "description": "Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps."}, "pipeline_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity pipeline.", "readOnly": true}, "quote_process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote process."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the step within its pipeline or process; lower values appear first."}, "timeframe": {"type": "integer", "format": "int32", "example": 1, "description": "Expected number of days a record should spend in this step. Used to flag overdue records."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "documents": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to CloudObjectStepRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectStepRelation' object for properties."}, "description": "Files attached to the step (e.g. step-specific documentation or templates)."}, "step_checklists": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to StepChecklist. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'StepChecklist' object for properties."}, "description": "Checklist items the user must complete before moving a record out of this step."}}, "required": ["is_delete_protected", "id", "name"]}, "createStepInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "description": {"type": "string", "example": "string", "description": "Free-text description shown in the step UI."}, "has_readonly_form": {"type": "boolean", "example": false, "description": "When true, the record form is read-only while a record is in this step."}, "has_version_increment": {"type": "boolean", "example": false, "description": "When true, transitioning a record into this step bumps its version counter."}, "lead_process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead process."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "percent": {"type": "integer", "format": "int32", "example": 1, "description": "Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps."}, "pipeline_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity pipeline.", "readOnly": true}, "quote_process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote process."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the step within its pipeline or process; lower values appear first."}, "timeframe": {"type": "integer", "format": "int32", "example": 1, "description": "Expected number of days a record should spend in this step. Used to flag overdue records."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectStepRelation, see: 'createCloudObjectStepRelationInput' object for properties."}, "description": "Files attached to the step (e.g. step-specific documentation or templates)."}, "step_checklists": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to StepChecklist, see: 'createStepChecklistInput' object for properties."}, "description": "Checklist items the user must complete before moving a record out of this step."}}, "required": ["name"]}, "updateStepInput": {"properties": {"description": {"type": "string", "example": "string", "description": "Free-text description shown in the step UI."}, "has_readonly_form": {"type": "boolean", "example": false, "description": "When true, the record form is read-only while a record is in this step."}, "has_version_increment": {"type": "boolean", "example": false, "description": "When true, transitioning a record into this step bumps its version counter."}, "lead_process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead process."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "percent": {"type": "integer", "format": "int32", "example": 1, "description": "Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps."}, "quote_process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote process."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the step within its pipeline or process; lower values appear first."}, "timeframe": {"type": "integer", "format": "int32", "example": 1, "description": "Expected number of days a record should spend in this step. Used to flag overdue records."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectStepRelation, see: 'updateCloudObjectStepRelationInput' object for properties."}, "description": "Files attached to the step (e.g. step-specific documentation or templates)."}, "step_checklists": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to StepChecklist, see: 'updateStepChecklistInput' object for properties."}, "description": "Checklist items the user must complete before moving a record out of this step."}}}, "batchStepInput": {"properties": {"description": {"type": "string", "example": "string", "description": "Free-text description shown in the step UI."}, "has_readonly_form": {"type": "boolean", "example": false, "description": "When true, the record form is read-only while a record is in this step."}, "has_version_increment": {"type": "boolean", "example": false, "description": "When true, transitioning a record into this step bumps its version counter."}, "lead_process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead process."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "percent": {"type": "integer", "format": "int32", "example": 1, "description": "Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps."}, "quote_process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the quote process."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the step within its pipeline or process; lower values appear first."}, "timeframe": {"type": "integer", "format": "int32", "example": 1, "description": "Expected number of days a record should spend in this step. Used to flag overdue records."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectStepRelation, see: 'updateCloudObjectStepRelationInput' object for properties."}, "description": "Files attached to the step (e.g. step-specific documentation or templates)."}, "step_checklists": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to StepChecklist, see: 'updateStepChecklistInput' object for properties."}, "description": "Checklist items the user must complete before moving a record out of this step."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "StepChecklist": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "appointment_type": {"type": "string", "format": "uri", "description": "Appointment type that satisfies this checklist item. Set when activity_type_id resolves to an AppointmentType.\n\nRelation to AppointmentType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentType' object for properties."}, "task_type": {"type": "string", "format": "uri", "description": "Task type that satisfies this checklist item. Set when activity_type_id resolves to a TaskType.\n\nRelation to TaskType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TaskType' object for properties."}, "cloud_object_template": {"type": "string", "format": "uri", "description": "Cloud object template that the checklist item should fill and attach to the record.\n\nRelation to CloudObjectTemplate. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectTemplate' object for properties."}, "email_sequence": {"type": "string", "format": "uri", "description": "Email sequence the item should enroll the record into.\n\nRelation to EmailSequence. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailSequence' object for properties."}, "field": {"type": "string", "format": "uri", "description": "Field whose value satisfies this checklist item. Set when item_type is FieldType.\n\nRelation to Field. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Field' object for properties."}, "process": {"type": "string", "format": "uri", "description": "Process the item should run. Set when item_type is ProcessType.\n\nRelation to Process. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Process' object for properties."}, "send_email_field": {"type": "string", "format": "uri", "description": "Field that supplies the recipient email address when the checklist item triggers sending an email.\n\nRelation to Field. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Field' object for properties."}, "send_email_template": {"type": "string", "format": "uri", "description": "Email template used when the checklist item triggers sending an email.\n\nRelation to EmailTemplate. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailTemplate' object for properties."}, "step": {"type": "string", "format": "uri", "description": "Pipeline or process step this checklist item belongs to.\n\nRelation to Step. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Step' object for properties."}, "activity_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment or task type that satisfies the checklist item, or empty when the item is not activity-based."}, "cloud_object_format": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Default, 1 - Pdf", "example": 0, "enum": [0, 1]}, "cloud_object_template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the cloud object template."}, "description": {"type": "string", "example": "string", "description": "Free-text description shown alongside the checklist item."}, "email_sequence_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email sequence."}, "field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the related field."}, "item_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Default, 2 - ActivityType, 3 - FieldType, 4 - CreateNote, 5 - AttachDocument, 6 - SendEmail, 7 - UseDocumentTemplate, 8 - EnrollToEmailSequence, 9 - RunProcess, 10 - MapSalesRole, 11 - CreateInfluenceMap", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]}, "item_validation": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Required, 2 - RelatedActivityCompleted, 3 - RelatedActivityLinked", "example": 1, "enum": [1, 2, 3]}, "label": {"type": "string", "example": "string", "description": "Display label of the checklist item."}, "label_use_lang": {"type": "boolean", "example": false, "description": "When true, label is treated as a translation key and localized in the UI; otherwise the literal text is shown."}, "process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the related process."}, "send_email_field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the recipient field."}, "send_email_template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email template."}, "sort_order": {"type": "integer", "format": "int32", "example": 1, "description": "Position of the checklist item within its step; lower values appear first.", "readOnly": true}, "step_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the step."}, "visibility_condition": {"type": "string", "format": "binary", "example": "blob", "description": "Filter expression that controls when the checklist item is shown. The item is visible only when the record matches this filter; defaults to a no-op filter matching all records."}, "visibility_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Always, 1 - Condition", "example": 0, "enum": [0, 1]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sales_roles": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to StepChecklistSalesRoleRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'StepChecklistSalesRoleRelation' object for properties."}, "description": "Sales roles the checklist item is shown to. Empty means the item is shown to all roles."}}, "required": ["is_delete_protected", "id", "step", "sort_order", "step_id", "visibility_condition"]}, "createStepChecklistInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "cloud_object_template": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Cloud object template that the checklist item should fill and attach to the record.\n\nRelation to CloudObjectTemplate, see: 'createCloudObjectTemplateInput' object for properties."}, "activity_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment or task type that satisfies the checklist item, or empty when the item is not activity-based."}, "cloud_object_format": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Default, 1 - Pdf", "example": 0, "enum": [0, 1]}, "cloud_object_template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the cloud object template."}, "description": {"type": "string", "example": "string", "description": "Free-text description shown alongside the checklist item."}, "email_sequence_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email sequence."}, "field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the related field."}, "item_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Default, 2 - ActivityType, 3 - FieldType, 4 - CreateNote, 5 - AttachDocument, 6 - SendEmail, 7 - UseDocumentTemplate, 8 - EnrollToEmailSequence, 9 - RunProcess, 10 - MapSalesRole, 11 - CreateInfluenceMap", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]}, "item_validation": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Required, 2 - RelatedActivityCompleted, 3 - RelatedActivityLinked", "example": 1, "enum": [1, 2, 3]}, "label": {"type": "string", "example": "string", "description": "Display label of the checklist item."}, "label_use_lang": {"type": "boolean", "example": false, "description": "When true, label is treated as a translation key and localized in the UI; otherwise the literal text is shown."}, "process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the related process."}, "send_email_field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the recipient field."}, "send_email_template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email template."}, "step_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the step."}, "visibility_condition": {"type": "string", "format": "binary", "example": "blob", "description": "Filter expression that controls when the checklist item is shown. The item is visible only when the record matches this filter; defaults to a no-op filter matching all records."}, "visibility_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Always, 1 - Condition", "example": 0, "enum": [0, 1]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sales_roles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to StepChecklistSalesRoleRelation, see: 'createStepChecklistSalesRoleRelationInput' object for properties."}, "description": "Sales roles the checklist item is shown to. Empty means the item is shown to all roles."}}, "required": ["step_id", "visibility_condition"]}, "updateStepChecklistInput": {"properties": {"cloud_object_template": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Cloud object template that the checklist item should fill and attach to the record.\n\nRelation to CloudObjectTemplate, see: 'updateCloudObjectTemplateInput' object for properties."}, "activity_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment or task type that satisfies the checklist item, or empty when the item is not activity-based."}, "cloud_object_format": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Default, 1 - Pdf", "example": 0, "enum": [0, 1]}, "cloud_object_template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the cloud object template."}, "description": {"type": "string", "example": "string", "description": "Free-text description shown alongside the checklist item."}, "email_sequence_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email sequence."}, "field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the related field."}, "item_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Default, 2 - ActivityType, 3 - FieldType, 4 - CreateNote, 5 - AttachDocument, 6 - SendEmail, 7 - UseDocumentTemplate, 8 - EnrollToEmailSequence, 9 - RunProcess, 10 - MapSalesRole, 11 - CreateInfluenceMap", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]}, "item_validation": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Required, 2 - RelatedActivityCompleted, 3 - RelatedActivityLinked", "example": 1, "enum": [1, 2, 3]}, "label": {"type": "string", "example": "string", "description": "Display label of the checklist item."}, "label_use_lang": {"type": "boolean", "example": false, "description": "When true, label is treated as a translation key and localized in the UI; otherwise the literal text is shown."}, "process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the related process."}, "send_email_field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the recipient field."}, "send_email_template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email template."}, "step_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the step."}, "visibility_condition": {"type": "string", "format": "binary", "example": "blob", "description": "Filter expression that controls when the checklist item is shown. The item is visible only when the record matches this filter; defaults to a no-op filter matching all records."}, "visibility_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Always, 1 - Condition", "example": 0, "enum": [0, 1]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sales_roles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to StepChecklistSalesRoleRelation, see: 'updateStepChecklistSalesRoleRelationInput' object for properties."}, "description": "Sales roles the checklist item is shown to. Empty means the item is shown to all roles."}}}, "batchStepChecklistInput": {"properties": {"cloud_object_template": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Cloud object template that the checklist item should fill and attach to the record.\n\nRelation to CloudObjectTemplate, see: 'updateCloudObjectTemplateInput' object for properties."}, "activity_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment or task type that satisfies the checklist item, or empty when the item is not activity-based."}, "cloud_object_format": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Default, 1 - Pdf", "example": 0, "enum": [0, 1]}, "cloud_object_template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the cloud object template."}, "description": {"type": "string", "example": "string", "description": "Free-text description shown alongside the checklist item."}, "email_sequence_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email sequence."}, "field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the related field."}, "item_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Default, 2 - ActivityType, 3 - FieldType, 4 - CreateNote, 5 - AttachDocument, 6 - SendEmail, 7 - UseDocumentTemplate, 8 - EnrollToEmailSequence, 9 - RunProcess, 10 - MapSalesRole, 11 - CreateInfluenceMap", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]}, "item_validation": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Required, 2 - RelatedActivityCompleted, 3 - RelatedActivityLinked", "example": 1, "enum": [1, 2, 3]}, "label": {"type": "string", "example": "string", "description": "Display label of the checklist item."}, "label_use_lang": {"type": "boolean", "example": false, "description": "When true, label is treated as a translation key and localized in the UI; otherwise the literal text is shown."}, "process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the related process."}, "send_email_field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the recipient field."}, "send_email_template_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the email template."}, "step_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the step."}, "visibility_condition": {"type": "string", "format": "binary", "example": "blob", "description": "Filter expression that controls when the checklist item is shown. The item is visible only when the record matches this filter; defaults to a no-op filter matching all records."}, "visibility_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Always, 1 - Condition", "example": 0, "enum": [0, 1]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sales_roles": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to StepChecklistSalesRoleRelation, see: 'updateStepChecklistSalesRoleRelationInput' object for properties."}, "description": "Sales roles the checklist item is shown to. Empty means the item is shown to all roles."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "StepChecklistSalesRoleRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "sales_role": {"type": "string", "format": "uri", "description": "Sales role that sees the checklist item.\n\nRelation to SalesRole. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesRole' object for properties."}, "step_checklist": {"type": "string", "format": "uri", "description": "Checklist item the role is granted access to.\n\nRelation to StepChecklist. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'StepChecklist' object for properties."}, "sales_role_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales role."}, "step_checklist_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the checklist item."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "sales_role", "step_checklist", "sales_role_id", "step_checklist_id"]}, "createStepChecklistSalesRoleRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "sales_role_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales role."}, "step_checklist_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the checklist item."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["sales_role_id", "step_checklist_id"]}, "updateStepChecklistSalesRoleRelationInput": {"properties": {"sales_role_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales role."}, "step_checklist_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the checklist item."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchStepChecklistSalesRoleRelationInput": {"properties": {"sales_role_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales role."}, "step_checklist_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the checklist item."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Tag": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "creator": {"type": "string", "format": "uri", "description": "User who created the tag.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "allowed_entity_type_ids": {"type": "object", "description": "For tags scoped to specific record types (e.g. specific Account types), the list of type ids the tag can be assigned to. Empty/null means no per-type restriction."}, "color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the tag, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue."}, "creator_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the creating user."}, "entity_api_name": {"type": "string", "example": "string", "description": "For tags scoped to custom entities, the api name of the custom entity the tag belongs to. Required for custom-entity tags and must be empty for all other tags."}, "is_enabled": {"type": "boolean", "example": false, "description": "When false, the tag is hidden in pickers and cannot be assigned to new records."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "supported_entities": {"type": "string", "example": 1, "enum": [1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024], "description": "Bit flag of entity kinds the tag can be attached to (Contact, Account, Opportunity, Lead, Project, Email, Process, Appointment, Task)."}, "use_lang": {"type": "boolean", "example": false, "description": "When true, the tag name is treated as a translation key and localized in the UI; otherwise the literal name is shown."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "color", "name"]}, "createTagInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "allowed_entity_type_ids": {"type": "object", "description": "For tags scoped to specific record types (e.g. specific Account types), the list of type ids the tag can be assigned to. Empty/null means no per-type restriction."}, "color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the tag, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue."}, "creator_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the creating user."}, "entity_api_name": {"type": "string", "example": "string", "description": "For tags scoped to custom entities, the api name of the custom entity the tag belongs to. Required for custom-entity tags and must be empty for all other tags."}, "is_enabled": {"type": "boolean", "example": false, "description": "When false, the tag is hidden in pickers and cannot be assigned to new records."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "supported_entities": {"type": "string", "example": 1, "enum": [1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024], "description": "Bit flag of entity kinds the tag can be attached to (Contact, Account, Opportunity, Lead, Project, Email, Process, Appointment, Task)."}, "use_lang": {"type": "boolean", "example": false, "description": "When true, the tag name is treated as a translation key and localized in the UI; otherwise the literal name is shown."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["color", "name"]}, "updateTagInput": {"properties": {"allowed_entity_type_ids": {"type": "object", "description": "For tags scoped to specific record types (e.g. specific Account types), the list of type ids the tag can be assigned to. Empty/null means no per-type restriction."}, "color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the tag, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue."}, "creator_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the creating user."}, "entity_api_name": {"type": "string", "example": "string", "description": "For tags scoped to custom entities, the api name of the custom entity the tag belongs to. Required for custom-entity tags and must be empty for all other tags."}, "is_enabled": {"type": "boolean", "example": false, "description": "When false, the tag is hidden in pickers and cannot be assigned to new records."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "use_lang": {"type": "boolean", "example": false, "description": "When true, the tag name is treated as a translation key and localized in the UI; otherwise the literal name is shown."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchTagInput": {"properties": {"allowed_entity_type_ids": {"type": "object", "description": "For tags scoped to specific record types (e.g. specific Account types), the list of type ids the tag can be assigned to. Empty/null means no per-type restriction."}, "color": {"type": "integer", "format": "int32", "example": 1, "description": "Display color of the tag, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue."}, "creator_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the creating user."}, "entity_api_name": {"type": "string", "example": "string", "description": "For tags scoped to custom entities, the api name of the custom entity the tag belongs to. Required for custom-entity tags and must be empty for all other tags."}, "is_enabled": {"type": "boolean", "example": false, "description": "When false, the tag is hidden in pickers and cannot be assigned to new records."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "use_lang": {"type": "boolean", "example": false, "description": "When true, the tag name is treated as a translation key and localized in the UI; otherwise the literal name is shown."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "TagRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account": {"type": "string", "format": "uri", "description": "Account the tag is attached to, or empty when not attached to an account.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "appointment": {"type": "string", "format": "uri", "description": "Appointment the tag is attached to, or empty when not attached to an appointment.\n\nRelation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties."}, "contact": {"type": "string", "format": "uri", "description": "Contact the tag is attached to, or empty when not attached to a contact.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "custom_entity": {"type": "string", "format": "uri", "description": "Custom entity record the tag is attached to, or empty when not attached to a custom entity record.\n\nRelation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties."}, "email": {"type": "string", "format": "uri", "description": "Email the tag is attached to, or empty when not attached to an email.\n\nRelation to Email. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Email' object for properties."}, "lead": {"type": "string", "format": "uri", "description": "Lead the tag is attached to, or empty when not attached to a lead.\n\nRelation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties."}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity the tag is attached to, or empty when not attached to an opportunity.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "process": {"type": "string", "format": "uri", "description": "Sales process the tag is attached to, or empty when not attached to a process.\n\nRelation to Process. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Process' object for properties."}, "project": {"type": "string", "format": "uri", "description": "Project the tag is attached to, or empty when not attached to a project.\n\nRelation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties."}, "quote": {"type": "string", "format": "uri", "description": "Quote the tag is attached to, or empty when not attached to a quote.\n\nRelation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties."}, "tag": {"type": "string", "format": "uri", "description": "Tag being attached to the record.\n\nRelation to Tag. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Tag' object for properties."}, "task": {"type": "string", "format": "uri", "description": "Task the tag is attached to, or empty when not attached to a task.\n\nRelation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "appointment_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked appointment."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked email."}, "lead_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead."}, "oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked opportunity."}, "process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked sales process."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "tag_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the tag."}, "task_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked task."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "tag", "tag_id"]}, "createTagRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "appointment_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked appointment."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked email."}, "lead_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead."}, "oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked opportunity."}, "process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked sales process."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "tag_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the tag."}, "task_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked task."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["tag_id"]}, "updateTagRelationInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "appointment_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked appointment."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked email."}, "lead_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead."}, "oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked opportunity."}, "process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked sales process."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "tag_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the tag."}, "task_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked task."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchTagRelationInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "appointment_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked appointment."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "custom_entity_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked custom entity record."}, "email_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked email."}, "lead_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked lead."}, "oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked opportunity."}, "process_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked sales process."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote."}, "tag_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the tag."}, "task_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked task."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Target": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "currency": {"type": "string", "format": "uri", "description": "Currency the target value is expressed in. Required when calculation_type is a currency-based metric.\n\nRelation to Currency. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Currency' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "User who owns the target.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "target_client": {"type": "string", "format": "uri", "description": "User the target is set on (the assignee). Required for User-type targets; null for group targets.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "calculation_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Revenue, 2 - LeadQualified, 3 - LeadCreated", "example": 1, "enum": [1, 2, 3]}, "currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the target currency."}, "description": {"type": "string", "example": "string", "description": "Free-text description shown alongside the target."}, "is_active": {"type": "boolean", "example": false, "description": "When true, the target is currently being tracked; when false, the target is a draft or has been deactivated."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "period_from": {"type": "string", "format": "date", "example": "2019-01-01", "description": "First date of the active target period. Set when is_active is true; recomputed from settings.period when activated."}, "period_to": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Last date of the active target period."}, "settings": {"type": "string", "format": "binary", "example": "blob", "description": "Target configuration: period (year, quarter/month etc.), value, fragment breakdown and indicator inputs. Stored as a JSON document."}, "target_client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the assignee user."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - User, 2 - GroupFromUser, 3 - GroupFromExisting, 4 - Simulated", "example": 1, "enum": [1, 2, 3, 4]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "child_targets": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to TargetRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TargetRelation' object for properties."}, "description": "User-level child targets that aggregate into this group target."}}, "required": ["is_delete_protected", "id", "currency", "owner", "is_active", "name", "owner_id", "settings"]}, "createTargetInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "calculation_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Revenue, 2 - LeadQualified, 3 - LeadCreated", "example": 1, "enum": [1, 2, 3]}, "currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the target currency."}, "description": {"type": "string", "example": "string", "description": "Free-text description shown alongside the target."}, "is_active": {"type": "boolean", "example": false, "description": "When true, the target is currently being tracked; when false, the target is a draft or has been deactivated."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "period_from": {"type": "string", "format": "date", "example": "2019-01-01", "description": "First date of the active target period. Set when is_active is true; recomputed from settings.period when activated."}, "period_to": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Last date of the active target period."}, "target_client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the assignee user."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - User, 2 - GroupFromUser, 3 - GroupFromExisting, 4 - Simulated", "example": 1, "enum": [1, 2, 3, 4]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "child_targets": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TargetRelation, see: 'createTargetRelationInput' object for properties."}, "description": "User-level child targets that aggregate into this group target."}}, "required": ["is_active", "name", "owner_id"]}, "updateTargetInput": {"properties": {"calculation_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Revenue, 2 - LeadQualified, 3 - LeadCreated", "example": 1, "enum": [1, 2, 3]}, "currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the target currency."}, "description": {"type": "string", "example": "string", "description": "Free-text description shown alongside the target."}, "is_active": {"type": "boolean", "example": false, "description": "When true, the target is currently being tracked; when false, the target is a draft or has been deactivated."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "period_from": {"type": "string", "format": "date", "example": "2019-01-01", "description": "First date of the active target period. Set when is_active is true; recomputed from settings.period when activated."}, "period_to": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Last date of the active target period."}, "target_client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the assignee user."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - User, 2 - GroupFromUser, 3 - GroupFromExisting, 4 - Simulated", "example": 1, "enum": [1, 2, 3, 4]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "child_targets": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TargetRelation, see: 'updateTargetRelationInput' object for properties."}, "description": "User-level child targets that aggregate into this group target."}}}, "batchTargetInput": {"properties": {"calculation_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Revenue, 2 - LeadQualified, 3 - LeadCreated", "example": 1, "enum": [1, 2, 3]}, "currency_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the target currency."}, "description": {"type": "string", "example": "string", "description": "Free-text description shown alongside the target."}, "is_active": {"type": "boolean", "example": false, "description": "When true, the target is currently being tracked; when false, the target is a draft or has been deactivated."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the owning user."}, "period_from": {"type": "string", "format": "date", "example": "2019-01-01", "description": "First date of the active target period. Set when is_active is true; recomputed from settings.period when activated."}, "period_to": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Last date of the active target period."}, "target_client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the assignee user."}, "type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - User, 2 - GroupFromUser, 3 - GroupFromExisting, 4 - Simulated", "example": 1, "enum": [1, 2, 3, 4]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "child_targets": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TargetRelation, see: 'updateTargetRelationInput' object for properties."}, "description": "User-level child targets that aggregate into this group target."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "TargetRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "group_target": {"type": "string", "format": "uri", "description": "Parent group target that aggregates the user target.\n\nRelation to Target. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Target' object for properties."}, "user_target": {"type": "string", "format": "uri", "description": "Child user target rolling up into the group target.\n\nRelation to Target. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Target' object for properties."}, "group_target_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the group target."}, "user_target_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user target."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "group_target", "user_target", "group_target_id", "user_target_id"]}, "createTargetRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "group_target_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the group target."}, "user_target_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user target."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["group_target_id", "user_target_id"]}, "updateTargetRelationInput": {"properties": {"group_target_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the group target."}, "user_target_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user target."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchTargetRelationInput": {"properties": {"group_target_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the group target."}, "user_target_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user target."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Task": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "active_reminder": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the next pending reminder configured for the activity (reminder time, due date or end date as applicable). Empty when no reminder is pending."}, "media_transcription_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked Media record holding the activity's call recording / transcription, when available."}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "activity_type": {"type": "string", "format": "uri", "description": "Task type that classifies this task (e.g. Task, Call, Email). Drives form layout and icon.\n\nRelation to TaskType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TaskType' object for properties."}, "call": {"type": "string", "format": "uri", "description": "Call record associated with this task when the task represents a phone call.\n\nRelation to Call. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Call' object for properties."}, "call_outcome": {"type": "string", "format": "uri", "description": "Configurable outcome of the call (e.g. Reached, Voicemail, No Answer).\n\nRelation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties."}, "currency_exchange_rates_list": {"type": "string", "format": "uri", "description": "Currency exchange rate list used to convert monetary fields linked to this task. Empty to inherit the team space default.\n\nRelation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRatesList' object for properties."}, "owner": {"type": "string", "format": "uri", "description": "Sales user who owns this task. May be empty when the task is unassigned and available for take-over.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit this task is assigned to. Determines which team members can see the record under unit-based sharing.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "activity_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the task type."}, "call_duration": {"type": "integer", "format": "int32", "example": 1, "description": "Duration of the recorded call. Set automatically when the task is linked to a call log."}, "call_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked call record."}, "call_outcome_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the call outcome value."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this task."}, "description": {"type": "string", "example": "string", "description": "Free-form description of what the task entails."}, "due_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date by which the task is expected to be completed."}, "duration": {"type": "number", "format": "double", "example": "4.32", "description": "Estimated duration of the task. Stored as a duration value (days/hours/minutes)."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the task owner."}, "priority": {"type": "integer", "description": "Priority level of the task (e.g. Low, Normal, High, Urgent).\n\nInteger enum value: 1 - Low, 2 - Medium, 3 - High", "example": 1, "enum": [1, 2, 3]}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users).\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when work on the task is scheduled to begin."}, "status": {"type": "integer", "description": "Current status of the task (NotStarted, InProgress, Completed, Deferred). Toggling to Completed marks any linked checklist items as done.\n\nInteger enum value: 1 - NotStarted, 2 - InProgress, 3 - Waiting, 4 - Completed, 5 - Deferred", "example": 1, "enum": [1, 2, 3, 4, 5]}, "subject": {"type": "string", "example": "string", "description": "Short summary line shown in lists and notifications."}, "table_name": {"type": "string", "example": "string", "description": "Discriminator identifying the concrete record type \u2014 always \"task\" for Task records. Read-only; useful when consuming polymorphic Activity results.", "readOnly": true}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sharing_units": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to TaskSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TaskSharingSalesUnitRelation' object for properties."}, "description": "Sales units that have been granted shared access to this task. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to TaskSharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TaskSharingClientRelation' object for properties."}, "description": "Users that have been granted shared access to this task. Editable only when share_mode allows user sharing."}, "account_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties."}, "description": "Accounts this task is linked to."}, "contact_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties."}, "description": "Contacts this task is linked to."}, "lead_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties."}, "description": "Leads this task is linked to."}, "opportunity_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties."}, "description": "Opportunities this task is linked to."}, "project_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties."}, "description": "Projects this task is linked to, including the per-objective ordering."}, "quote_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties."}, "description": "Quotes this task is linked to."}, "custom_entity_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ActivityRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityRelation' object for properties."}, "description": "Custom entity records this task is linked to."}, "exchange_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "gapi_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "o365_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "reminder": {"type": "string", "format": "uri", "description": "Reminder set by the current authenticated user for this task. Per-user; empty when no reminder has been set.\n\nRelation to TaskReminder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TaskReminder' object for properties."}, "task_recurrence": {"type": "string", "format": "uri", "description": "Recurrence schedule generating periodic copies of this task, or empty when no recurrence is set up.\n\nRelation to TaskRecurrence. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TaskRecurrence' object for properties."}, "documents": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties."}, "description": "Documents linked to this task."}, "comments": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to ActivityComment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ActivityComment' object for properties."}, "description": "Comments authored on this task."}, "tags": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to TagRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TagRelation' object for properties."}, "description": "Tag labels applied to this task."}, "formatted_name": {"type": "string", "example": "string", "description": "Display name of the task (alias of subject)."}, "modified_by_user": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera."}}, "required": ["is_delete_protected", "id", "activity_type", "unit", "subject", "table_name", "formatted_name"]}, "createTaskInput": {"properties": {"media_transcription_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked Media record holding the activity's call recording / transcription, when available."}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "activity_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the task type."}, "call_duration": {"type": "integer", "format": "int32", "example": 1, "description": "Duration of the recorded call. Set automatically when the task is linked to a call log."}, "call_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked call record."}, "call_outcome_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the call outcome value."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this task."}, "description": {"type": "string", "example": "string", "description": "Free-form description of what the task entails."}, "due_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date by which the task is expected to be completed."}, "duration": {"type": "number", "format": "double", "example": "4.32", "description": "Estimated duration of the task. Stored as a duration value (days/hours/minutes)."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the task owner."}, "priority": {"type": "integer", "description": "Priority level of the task (e.g. Low, Normal, High, Urgent).\n\nInteger enum value: 1 - Low, 2 - Medium, 3 - High", "example": 1, "enum": [1, 2, 3]}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users).\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when work on the task is scheduled to begin."}, "status": {"type": "integer", "description": "Current status of the task (NotStarted, InProgress, Completed, Deferred). Toggling to Completed marks any linked checklist items as done.\n\nInteger enum value: 1 - NotStarted, 2 - InProgress, 3 - Waiting, 4 - Completed, 5 - Deferred", "example": 1, "enum": [1, 2, 3, 4, 5]}, "subject": {"type": "string", "example": "string", "description": "Short summary line shown in lists and notifications."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TaskSharingSalesUnitRelation, see: 'createTaskSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this task. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TaskSharingClientRelation, see: 'createTaskSharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this task. Editable only when share_mode allows user sharing."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties."}, "description": "Accounts this task is linked to."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties."}, "description": "Contacts this task is linked to."}, "lead_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties."}, "description": "Leads this task is linked to."}, "opportunity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties."}, "description": "Opportunities this task is linked to."}, "project_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties."}, "description": "Projects this task is linked to, including the per-objective ordering."}, "quote_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties."}, "description": "Quotes this task is linked to."}, "custom_entity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'createActivityRelationInput' object for properties."}, "description": "Custom entity records this task is linked to."}, "reminder": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Reminder set by the current authenticated user for this task. Per-user; empty when no reminder has been set.\n\nRelation to TaskReminder, see: 'createTaskReminderInput' object for properties."}, "task_recurrence": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Recurrence schedule generating periodic copies of this task, or empty when no recurrence is set up.\n\nRelation to TaskRecurrence, see: 'createTaskRecurrenceInput' object for properties."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this task."}, "comments": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityComment, see: 'createActivityCommentInput' object for properties."}, "description": "Comments authored on this task."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'createTagRelationInput' object for properties."}, "description": "Tag labels applied to this task."}, "call_sid": {"type": "string", "example": "string", "description": ""}}, "required": ["subject"]}, "updateTaskInput": {"properties": {"media_transcription_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked Media record holding the activity's call recording / transcription, when available."}, "activity_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the task type."}, "call_duration": {"type": "integer", "format": "int32", "example": 1, "description": "Duration of the recorded call. Set automatically when the task is linked to a call log."}, "call_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked call record."}, "call_outcome_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the call outcome value."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this task."}, "description": {"type": "string", "example": "string", "description": "Free-form description of what the task entails."}, "due_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date by which the task is expected to be completed."}, "duration": {"type": "number", "format": "double", "example": "4.32", "description": "Estimated duration of the task. Stored as a duration value (days/hours/minutes)."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the task owner."}, "priority": {"type": "integer", "description": "Priority level of the task (e.g. Low, Normal, High, Urgent).\n\nInteger enum value: 1 - Low, 2 - Medium, 3 - High", "example": 1, "enum": [1, 2, 3]}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users).\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when work on the task is scheduled to begin."}, "status": {"type": "integer", "description": "Current status of the task (NotStarted, InProgress, Completed, Deferred). Toggling to Completed marks any linked checklist items as done.\n\nInteger enum value: 1 - NotStarted, 2 - InProgress, 3 - Waiting, 4 - Completed, 5 - Deferred", "example": 1, "enum": [1, 2, 3, 4, 5]}, "subject": {"type": "string", "example": "string", "description": "Short summary line shown in lists and notifications."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TaskSharingSalesUnitRelation, see: 'updateTaskSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this task. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TaskSharingClientRelation, see: 'updateTaskSharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this task. Editable only when share_mode allows user sharing."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Accounts this task is linked to."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Contacts this task is linked to."}, "lead_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Leads this task is linked to."}, "opportunity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Opportunities this task is linked to."}, "project_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Projects this task is linked to, including the per-objective ordering."}, "quote_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Quotes this task is linked to."}, "custom_entity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Custom entity records this task is linked to."}, "exchange_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "gapi_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "o365_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "task_recurrence": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Recurrence schedule generating periodic copies of this task, or empty when no recurrence is set up.\n\nRelation to TaskRecurrence, see: 'updateTaskRecurrenceInput' object for properties."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this task."}, "comments": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityComment, see: 'updateActivityCommentInput' object for properties."}, "description": "Comments authored on this task."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'updateTagRelationInput' object for properties."}, "description": "Tag labels applied to this task."}, "call_sid": {"type": "string", "example": "string", "description": ""}}}, "batchTaskInput": {"properties": {"media_transcription_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked Media record holding the activity's call recording / transcription, when available."}, "activity_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the task type."}, "call_duration": {"type": "integer", "format": "int32", "example": 1, "description": "Duration of the recorded call. Set automatically when the task is linked to a call log."}, "call_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked call record."}, "call_outcome_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the call outcome value."}, "currency_exchange_rates_list_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the currency exchange rate list applied to this task."}, "description": {"type": "string", "example": "string", "description": "Free-form description of what the task entails."}, "due_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date by which the task is expected to be completed."}, "duration": {"type": "number", "format": "double", "example": "4.32", "description": "Estimated duration of the task. Stored as a duration value (days/hours/minutes)."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the task owner."}, "priority": {"type": "integer", "description": "Priority level of the task (e.g. Low, Normal, High, Urgent).\n\nInteger enum value: 1 - Low, 2 - Medium, 3 - High", "example": 1, "enum": [1, 2, 3]}, "share_mode": {"type": "integer", "description": "Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users).\n\nInteger enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit", "example": 0, "enum": [0, 1, 2, 3]}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date when work on the task is scheduled to begin."}, "status": {"type": "integer", "description": "Current status of the task (NotStarted, InProgress, Completed, Deferred). Toggling to Completed marks any linked checklist items as done.\n\nInteger enum value: 1 - NotStarted, 2 - InProgress, 3 - Waiting, 4 - Completed, 5 - Deferred", "example": 1, "enum": [1, 2, 3, 4, 5]}, "subject": {"type": "string", "example": "string", "description": "Short summary line shown in lists and notifications."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "sharing_units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TaskSharingSalesUnitRelation, see: 'updateTaskSharingSalesUnitRelationInput' object for properties."}, "description": "Sales units that have been granted shared access to this task. Editable only when share_mode allows unit sharing."}, "sharing_clients": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TaskSharingClientRelation, see: 'updateTaskSharingClientRelationInput' object for properties."}, "description": "Users that have been granted shared access to this task. Editable only when share_mode allows user sharing."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Accounts this task is linked to."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Contacts this task is linked to."}, "lead_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Leads this task is linked to."}, "opportunity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Opportunities this task is linked to."}, "project_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Projects this task is linked to, including the per-objective ordering."}, "quote_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Quotes this task is linked to."}, "custom_entity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties."}, "description": "Custom entity records this task is linked to."}, "exchange_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "gapi_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "o365_entity_id": {"type": "string", "example": "string", "description": "External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine."}, "task_recurrence": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Recurrence schedule generating periodic copies of this task, or empty when no recurrence is set up.\n\nRelation to TaskRecurrence, see: 'updateTaskRecurrenceInput' object for properties."}, "documents": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Documents linked to this task."}, "comments": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to ActivityComment, see: 'updateActivityCommentInput' object for properties."}, "description": "Comments authored on this task."}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TagRelation, see: 'updateTagRelationInput' object for properties."}, "description": "Tag labels applied to this task."}, "call_sid": {"type": "string", "example": "string", "description": ""}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "TaskRecurrence": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "task": {"type": "string", "format": "uri", "description": "Task this recurrence belongs to. Each recurrence is bound to exactly one task.\n\nRelation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties."}, "day": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative.\n\nInteger enum value: 1 - Day1, 2 - Day2, 3 - Day3, 4 - Day4, 5 - Day5, 6 - Day6, 7 - Day7, 8 - Day8, 9 - Day9, 10 - Day10, 11 - Day11, 12 - Day12, 13 - Day13, 14 - Day14, 15 - Day15, 16 - Day16, 17 - Day17, 18 - Day18, 19 - Day19, 20 - Day20, 21 - Day21, 22 - Day22, 23 - Day23, 24 - Day24, 25 - Day25, 26 - Day26, 27 - Day27, 28 - Day28, 29 - Day29, 30 - Day30, 31 - Day31", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31]}, "day_of_week": {"type": "string", "example": 1, "enum": [1, 2, 4, 8, 16, 32, 64], "description": "Bit Flag field, with limited combination of integer values.\n    \nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute."}, "end_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date information. The last date when no more other items should be created."}, "month": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only     for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative.\n\nInteger enum value: 1 - Month1, 2 - Month2, 3 - Month3, 4 - Month4, 5 - Month5, 6 - Month6, 7 - Month7, 8 - Month8, 9 - Month9, 10 - Month10, 11 - Month11, 12 - Month12", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]}, "occur_every": {"type": "integer", "format": "int32", "example": 1, "description": "Generic field wrapping sqlalchemy column, configurable by constructor.\n    Good for one-of fields / generated fields.\n     The number of units of a given recurrence type between     occurrences according to RecurrenceTypeEnum."}, "occurrences_count": {"type": "integer", "format": "int32", "example": 1, "description": "Whole natural number. The number of remaining occurrences. Each time a new     one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0,     recurrence is stopped. If -1, no limits are applied."}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date information. The effective start date of recurrence, which means each     next recurrence must be on or after this date."}, "task_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent task."}, "type": {"type": "integer", "description": "Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative, AfterNDays, AfterNWeeks, AfterNMonths, AfterNYears).\n\nInteger enum value: 0 - NotSet, 1 - Daily, 2 - Weekly, 3 - MonthlyRelative, 4 - MonthlyAbsolute, 5 - YearlyRelative, 6 - YearlyAbsolute, 7 - AfterNDays, 8 - AfterNWeeks, 9 - AfterNMonths, 10 - AfterNYears", "example": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]}, "week": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only     for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute.\n\nInteger enum value: -1 - WeekLast, 1 - Week1, 2 - Week2, 3 - Week3, 4 - Week4", "example": -1, "enum": [-1, 1, 2, 3, 4]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "task", "start_date", "task_id"]}, "createTaskRecurrenceInput": {"properties": {"apply_recurrence": {"type": "boolean", "example": false, "description": "Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply"}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "day": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative.\n\nInteger enum value: 1 - Day1, 2 - Day2, 3 - Day3, 4 - Day4, 5 - Day5, 6 - Day6, 7 - Day7, 8 - Day8, 9 - Day9, 10 - Day10, 11 - Day11, 12 - Day12, 13 - Day13, 14 - Day14, 15 - Day15, 16 - Day16, 17 - Day17, 18 - Day18, 19 - Day19, 20 - Day20, 21 - Day21, 22 - Day22, 23 - Day23, 24 - Day24, 25 - Day25, 26 - Day26, 27 - Day27, 28 - Day28, 29 - Day29, 30 - Day30, 31 - Day31", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31]}, "day_of_week": {"type": "string", "example": 1, "enum": [1, 2, 4, 8, 16, 32, 64], "description": "Bit Flag field, with limited combination of integer values.\n    \nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute."}, "end_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date information. The last date when no more other items should be created."}, "month": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only     for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative.\n\nInteger enum value: 1 - Month1, 2 - Month2, 3 - Month3, 4 - Month4, 5 - Month5, 6 - Month6, 7 - Month7, 8 - Month8, 9 - Month9, 10 - Month10, 11 - Month11, 12 - Month12", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]}, "occur_every": {"type": "integer", "format": "int32", "example": 1, "description": "Generic field wrapping sqlalchemy column, configurable by constructor.\n    Good for one-of fields / generated fields.\n     The number of units of a given recurrence type between     occurrences according to RecurrenceTypeEnum."}, "occurrences_count": {"type": "integer", "format": "int32", "example": 1, "description": "Whole natural number. The number of remaining occurrences. Each time a new     one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0,     recurrence is stopped. If -1, no limits are applied."}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date information. The effective start date of recurrence, which means each     next recurrence must be on or after this date."}, "task_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent task."}, "type": {"type": "integer", "description": "Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative, AfterNDays, AfterNWeeks, AfterNMonths, AfterNYears).\n\nInteger enum value: 0 - NotSet, 1 - Daily, 2 - Weekly, 3 - MonthlyRelative, 4 - MonthlyAbsolute, 5 - YearlyRelative, 6 - YearlyAbsolute, 7 - AfterNDays, 8 - AfterNWeeks, 9 - AfterNMonths, 10 - AfterNYears", "example": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]}, "week": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only     for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute.\n\nInteger enum value: -1 - WeekLast, 1 - Week1, 2 - Week2, 3 - Week3, 4 - Week4", "example": -1, "enum": [-1, 1, 2, 3, 4]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["start_date", "task_id"]}, "updateTaskRecurrenceInput": {"properties": {"apply_recurrence": {"type": "boolean", "example": false, "description": "Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply"}, "day": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative.\n\nInteger enum value: 1 - Day1, 2 - Day2, 3 - Day3, 4 - Day4, 5 - Day5, 6 - Day6, 7 - Day7, 8 - Day8, 9 - Day9, 10 - Day10, 11 - Day11, 12 - Day12, 13 - Day13, 14 - Day14, 15 - Day15, 16 - Day16, 17 - Day17, 18 - Day18, 19 - Day19, 20 - Day20, 21 - Day21, 22 - Day22, 23 - Day23, 24 - Day24, 25 - Day25, 26 - Day26, 27 - Day27, 28 - Day28, 29 - Day29, 30 - Day30, 31 - Day31", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31]}, "day_of_week": {"type": "string", "example": 1, "enum": [1, 2, 4, 8, 16, 32, 64], "description": "Bit Flag field, with limited combination of integer values.\n    \nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute."}, "end_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date information. The last date when no more other items should be created."}, "month": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only     for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative.\n\nInteger enum value: 1 - Month1, 2 - Month2, 3 - Month3, 4 - Month4, 5 - Month5, 6 - Month6, 7 - Month7, 8 - Month8, 9 - Month9, 10 - Month10, 11 - Month11, 12 - Month12", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]}, "occur_every": {"type": "integer", "format": "int32", "example": 1, "description": "Generic field wrapping sqlalchemy column, configurable by constructor.\n    Good for one-of fields / generated fields.\n     The number of units of a given recurrence type between     occurrences according to RecurrenceTypeEnum."}, "occurrences_count": {"type": "integer", "format": "int32", "example": 1, "description": "Whole natural number. The number of remaining occurrences. Each time a new     one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0,     recurrence is stopped. If -1, no limits are applied."}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date information. The effective start date of recurrence, which means each     next recurrence must be on or after this date."}, "task_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent task."}, "type": {"type": "integer", "description": "Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative, AfterNDays, AfterNWeeks, AfterNMonths, AfterNYears).\n\nInteger enum value: 0 - NotSet, 1 - Daily, 2 - Weekly, 3 - MonthlyRelative, 4 - MonthlyAbsolute, 5 - YearlyRelative, 6 - YearlyAbsolute, 7 - AfterNDays, 8 - AfterNWeeks, 9 - AfterNMonths, 10 - AfterNYears", "example": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]}, "week": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only     for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute.\n\nInteger enum value: -1 - WeekLast, 1 - Week1, 2 - Week2, 3 - Week3, 4 - Week4", "example": -1, "enum": [-1, 1, 2, 3, 4]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchTaskRecurrenceInput": {"properties": {"apply_recurrence": {"type": "boolean", "example": false, "description": "Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply"}, "day": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative.\n\nInteger enum value: 1 - Day1, 2 - Day2, 3 - Day3, 4 - Day4, 5 - Day5, 6 - Day6, 7 - Day7, 8 - Day8, 9 - Day9, 10 - Day10, 11 - Day11, 12 - Day12, 13 - Day13, 14 - Day14, 15 - Day15, 16 - Day16, 17 - Day17, 18 - Day18, 19 - Day19, 20 - Day20, 21 - Day21, 22 - Day22, 23 - Day23, 24 - Day24, 25 - Day25, 26 - Day26, 27 - Day27, 28 - Day28, 29 - Day29, 30 - Day30, 31 - Day31", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31]}, "day_of_week": {"type": "string", "example": 1, "enum": [1, 2, 4, 8, 16, 32, 64], "description": "Bit Flag field, with limited combination of integer values.\n    \nOptions:\nSunday = 1 (0b0000001)\nMonday = 2 (0b0000010)\nTuesday = 4 (0b0000100)\nWednesday = 8 (0b0001000)\nThursday = 16 (0b0010000)\nFriday = 32 (0b0100000)\nSaturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute."}, "end_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date information. The last date when no more other items should be created."}, "month": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only     for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative.\n\nInteger enum value: 1 - Month1, 2 - Month2, 3 - Month3, 4 - Month4, 5 - Month5, 6 - Month6, 7 - Month7, 8 - Month8, 9 - Month9, 10 - Month10, 11 - Month11, 12 - Month12", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]}, "occur_every": {"type": "integer", "format": "int32", "example": 1, "description": "Generic field wrapping sqlalchemy column, configurable by constructor.\n    Good for one-of fields / generated fields.\n     The number of units of a given recurrence type between     occurrences according to RecurrenceTypeEnum."}, "occurrences_count": {"type": "integer", "format": "int32", "example": 1, "description": "Whole natural number. The number of remaining occurrences. Each time a new     one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0,     recurrence is stopped. If -1, no limits are applied."}, "start_date": {"type": "string", "format": "date", "example": "2019-01-01", "description": "Date information. The effective start date of recurrence, which means each     next recurrence must be on or after this date."}, "task_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent task."}, "type": {"type": "integer", "description": "Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative, AfterNDays, AfterNWeeks, AfterNMonths, AfterNYears).\n\nInteger enum value: 0 - NotSet, 1 - Daily, 2 - Weekly, 3 - MonthlyRelative, 4 - MonthlyAbsolute, 5 - YearlyRelative, 6 - YearlyAbsolute, 7 - AfterNDays, 8 - AfterNWeeks, 9 - AfterNMonths, 10 - AfterNYears", "example": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]}, "week": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only     for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute.\n\nInteger enum value: -1 - WeekLast, 1 - Week1, 2 - Week2, 3 - Week3, 4 - Week4", "example": -1, "enum": [-1, 1, 2, 3, 4]}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "TaskReminder": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "owner": {"type": "string", "format": "uri", "description": "User who set this reminder. Reminders are per-user.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "task": {"type": "string", "format": "uri", "description": "Task this reminder belongs to.\n\nRelation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties."}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who set the reminder."}, "set_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp when the reminder should fire."}, "status": {"type": "integer", "description": "Current state of the reminder (e.g. NotSent, Sent, Snoozed, Dismissed).\n\nInteger enum value: 0 - Snoozed, 1 - Scheduled, 2 - Dismissed", "example": 0, "enum": [0, 1, 2]}, "task_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the task."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "owner", "task", "owner_id", "set_date", "task_id"]}, "createTaskReminderInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who set the reminder."}, "set_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp when the reminder should fire."}, "status": {"type": "integer", "description": "Current state of the reminder (e.g. NotSent, Sent, Snoozed, Dismissed).\n\nInteger enum value: 0 - Snoozed, 1 - Scheduled, 2 - Dismissed", "example": 0, "enum": [0, 1, 2]}, "task_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the task."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["owner_id", "set_date", "task_id"]}, "updateTaskReminderInput": {"properties": {"owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who set the reminder."}, "set_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp when the reminder should fire."}, "status": {"type": "integer", "description": "Current state of the reminder (e.g. NotSent, Sent, Snoozed, Dismissed).\n\nInteger enum value: 0 - Snoozed, 1 - Scheduled, 2 - Dismissed", "example": 0, "enum": [0, 1, 2]}, "task_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the task."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchTaskReminderInput": {"properties": {"owner_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who set the reminder."}, "set_date": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp when the reminder should fire."}, "status": {"type": "integer", "description": "Current state of the reminder (e.g. NotSent, Sent, Snoozed, Dismissed).\n\nInteger enum value: 0 - Snoozed, 1 - Scheduled, 2 - Dismissed", "example": 0, "enum": [0, 1, 2]}, "task_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the task."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "TaskSharingClientRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client": {"type": "string", "format": "uri", "description": "User the task is shared with.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "task": {"type": "string", "format": "uri", "description": "Task being shared.\n\nRelation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties."}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the task.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "task_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared task."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "client", "task", "client_id", "task_id"]}, "createTaskSharingClientRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the task.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "task_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared task."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["client_id", "task_id"]}, "updateTaskSharingClientRelationInput": {"properties": {"client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the task.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "task_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared task."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchTaskSharingClientRelationInput": {"properties": {"client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user."}, "role": {"type": "integer", "description": "Sharing role granting the user a specific access level (e.g. Read, Edit) on the task.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "task_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared task."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "TaskSharingSalesUnitRelation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "task": {"type": "string", "format": "uri", "description": "Task being shared.\n\nRelation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties."}, "unit": {"type": "string", "format": "uri", "description": "Sales unit the task is shared with.\n\nRelation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties."}, "role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the task.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "task_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared task."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "task", "unit", "task_id", "unit_id"]}, "createTaskSharingSalesUnitRelationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the task.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "task_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared task."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["task_id", "unit_id"]}, "updateTaskSharingSalesUnitRelationInput": {"properties": {"role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the task.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "task_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared task."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchTaskSharingSalesUnitRelationInput": {"properties": {"role": {"type": "integer", "description": "Sharing role granting the unit a specific access level (e.g. Read, Edit) on the task.\n\nInteger enum value: 1 - Watcher, 2 - Editor", "example": 1, "enum": [1, 2]}, "task_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the shared task."}, "unit_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sales unit."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "TaskType": {"properties": {"id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing tasks of this type."}, "icon": {"type": "integer", "description": "Icon used to display tasks of this type in the UI.\n\nInteger enum value: 0 - GeneralIcon, 1 - Task, 2 - Appointment, 3 - Call, 4 - Mail, 5 - Message, 6 - TicketingIntegration, 7 - DocumentManagement, 8 - EventManagement, 9 - AccountingSystem, 10 - MarketingCommunicationSystems, 11 - OrderProcessing, 12 - WebServices, 13 - ReturnMerchandiseAuthorizationSystems, 14 - SalesAutomatization, 15 - SmsMessaging, 16 - ErpSystems, 17 - DataAnalytics, 18 - Warehouses, 19 - ContactManagement, 20 - ContentManagementSystems, 21 - InventorySystems, 22 - Workflow, 23 - AssetManagementSystem", "example": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23]}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the task type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "is_published": {"type": "boolean", "example": false, "description": "True when the entity configuration is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "has_draft": {"type": "boolean", "example": false, "description": "Set to True if draft for entity exists and can be published"}, "is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "form_edit_api": {"type": "object", "description": "API-friendly form definition. Returns the published form merged with any pending draft changes; read via this field, modify via the underlying form_edit / form_lost field through drafts."}, "can_change_readonly": {"type": "boolean", "example": false, "description": "Returns if user can change readonly flag on this entity_type."}}, "required": ["id", "is_readonly", "name", "has_draft", "is_delete_protected", "form_edit_api"]}, "createTaskTypeInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing tasks of this type."}, "icon": {"type": "integer", "description": "Icon used to display tasks of this type in the UI.\n\nInteger enum value: 0 - GeneralIcon, 1 - Task, 2 - Appointment, 3 - Call, 4 - Mail, 5 - Message, 6 - TicketingIntegration, 7 - DocumentManagement, 8 - EventManagement, 9 - AccountingSystem, 10 - MarketingCommunicationSystems, 11 - OrderProcessing, 12 - WebServices, 13 - ReturnMerchandiseAuthorizationSystems, 14 - SalesAutomatization, 15 - SmsMessaging, 16 - ErpSystems, 17 - DataAnalytics, 18 - Warehouses, 19 - ContactManagement, 20 - ContentManagementSystems, 21 - InventorySystems, 22 - Workflow, 23 - AssetManagementSystem", "example": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23]}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the task type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "is_published": {"type": "boolean", "example": false, "description": "True when the entity configuration is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_readonly", "name"]}, "updateTaskTypeInput": {"properties": {"form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing tasks of this type."}, "icon": {"type": "integer", "description": "Icon used to display tasks of this type in the UI.\n\nInteger enum value: 0 - GeneralIcon, 1 - Task, 2 - Appointment, 3 - Call, 4 - Mail, 5 - Message, 6 - TicketingIntegration, 7 - DocumentManagement, 8 - EventManagement, 9 - AccountingSystem, 10 - MarketingCommunicationSystems, 11 - OrderProcessing, 12 - WebServices, 13 - ReturnMerchandiseAuthorizationSystems, 14 - SalesAutomatization, 15 - SmsMessaging, 16 - ErpSystems, 17 - DataAnalytics, 18 - Warehouses, 19 - ContactManagement, 20 - ContentManagementSystems, 21 - InventorySystems, 22 - Workflow, 23 - AssetManagementSystem", "example": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23]}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the task type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchTaskTypeInput": {"properties": {"form_edit": {"type": "object", "description": "JSON definition of the form layout used by the UI when creating or editing tasks of this type."}, "icon": {"type": "integer", "description": "Icon used to display tasks of this type in the UI.\n\nInteger enum value: 0 - GeneralIcon, 1 - Task, 2 - Appointment, 3 - Call, 4 - Mail, 5 - Message, 6 - TicketingIntegration, 7 - DocumentManagement, 8 - EventManagement, 9 - AccountingSystem, 10 - MarketingCommunicationSystems, 11 - OrderProcessing, 12 - WebServices, 13 - ReturnMerchandiseAuthorizationSystems, 14 - SalesAutomatization, 15 - SmsMessaging, 16 - ErpSystems, 17 - DataAnalytics, 18 - Warehouses, 19 - ContactManagement, 20 - ContentManagementSystems, 21 - InventorySystems, 22 - Workflow, 23 - AssetManagementSystem", "example": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23]}, "is_readonly": {"type": "boolean", "example": false, "description": "True when the task type is system-managed and cannot be edited or deleted by users."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "TextMessage": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "chat_conversation": {"type": "string", "format": "uri", "description": "Internal AI chat conversation this message belongs to, when applicable.\n\nRelation to ChatConversation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ChatConversation' object for properties."}, "text_message_conversation": {"type": "string", "format": "uri", "description": "Conversation this message belongs to. Empty for messages produced by AI chat that do not belong to a thread of customer conversation.\n\nRelation to TextMessageConversation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TextMessageConversation' object for properties."}, "chat_conversation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the chat conversation."}, "content": {"type": "string", "example": "string", "description": "Body of the message. May be plain text or a JSON payload (e.g. AI assistant examples / suggestions)."}, "datetime_sent": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the message was sent."}, "direction": {"type": "integer", "description": "Direction of the message (Incoming, Outgoing).\n\nInteger enum value: 1 - OutgoingEmail, 2 - IncomingEmail", "example": 1, "enum": [1, 2]}, "message_sid": {"type": "string", "example": "string", "description": "External message identifier from the SMS provider (e.g. Twilio Message SID)."}, "score": {"type": "integer", "format": "int32", "example": 1, "description": "Quality score given to the message by the user (e.g. for AI-suggested replies). Used to feed back into the suggestion engine."}, "status": {"type": "integer", "description": "Delivery status of the message (e.g. Sent, Delivered, Failed).\n\nInteger enum value: 1 - Sending, 2 - Sent, 3 - Failed, 4 - Received, 5 - Seen", "example": 1, "enum": [1, 2, 3, 4, 5]}, "text_message_conversation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the conversation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "attachments": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectRelation' object for properties."}, "description": "Files attached to the message (e.g. MMS attachments)."}, "content_as_html": {"type": "string", "example": "string", "description": "HTML-rendered version of the message body, ready for display in chat UIs."}, "data": {"type": "string", "format": "binary", "example": "blob", "description": "Structured AI payload of the message (examples or suggestions). Empty for regular text messages."}, "topic_prompts": {"type": "string", "format": "binary", "example": "blob", "description": "List of suggested follow-up prompts produced by the AI for this message. Empty when the AI did not produce prompts."}}, "required": ["is_delete_protected", "id", "content", "direction", "content_as_html", "data", "topic_prompts"]}, "createTextMessageInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "chat_conversation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the chat conversation."}, "content": {"type": "string", "example": "string", "description": "Body of the message. May be plain text or a JSON payload (e.g. AI assistant examples / suggestions)."}, "datetime_sent": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the message was sent."}, "direction": {"type": "integer", "description": "Direction of the message (Incoming, Outgoing).\n\nInteger enum value: 1 - OutgoingEmail, 2 - IncomingEmail", "example": 1, "enum": [1, 2]}, "message_sid": {"type": "string", "example": "string", "description": "External message identifier from the SMS provider (e.g. Twilio Message SID)."}, "score": {"type": "integer", "format": "int32", "example": 1, "description": "Quality score given to the message by the user (e.g. for AI-suggested replies). Used to feed back into the suggestion engine."}, "status": {"type": "integer", "description": "Delivery status of the message (e.g. Sent, Delivered, Failed).\n\nInteger enum value: 1 - Sending, 2 - Sent, 3 - Failed, 4 - Received, 5 - Seen", "example": 1, "enum": [1, 2, 3, 4, 5]}, "text_message_conversation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the conversation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "attachments": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties."}, "description": "Files attached to the message (e.g. MMS attachments)."}}, "required": ["content", "direction"]}, "updateTextMessageInput": {"properties": {"chat_conversation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the chat conversation."}, "content": {"type": "string", "example": "string", "description": "Body of the message. May be plain text or a JSON payload (e.g. AI assistant examples / suggestions)."}, "datetime_sent": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the message was sent."}, "direction": {"type": "integer", "description": "Direction of the message (Incoming, Outgoing).\n\nInteger enum value: 1 - OutgoingEmail, 2 - IncomingEmail", "example": 1, "enum": [1, 2]}, "message_sid": {"type": "string", "example": "string", "description": "External message identifier from the SMS provider (e.g. Twilio Message SID)."}, "score": {"type": "integer", "format": "int32", "example": 1, "description": "Quality score given to the message by the user (e.g. for AI-suggested replies). Used to feed back into the suggestion engine."}, "status": {"type": "integer", "description": "Delivery status of the message (e.g. Sent, Delivered, Failed).\n\nInteger enum value: 1 - Sending, 2 - Sent, 3 - Failed, 4 - Received, 5 - Seen", "example": 1, "enum": [1, 2, 3, 4, 5]}, "text_message_conversation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the conversation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "attachments": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Files attached to the message (e.g. MMS attachments)."}}}, "batchTextMessageInput": {"properties": {"chat_conversation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the chat conversation."}, "content": {"type": "string", "example": "string", "description": "Body of the message. May be plain text or a JSON payload (e.g. AI assistant examples / suggestions)."}, "datetime_sent": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Timestamp the message was sent."}, "direction": {"type": "integer", "description": "Direction of the message (Incoming, Outgoing).\n\nInteger enum value: 1 - OutgoingEmail, 2 - IncomingEmail", "example": 1, "enum": [1, 2]}, "message_sid": {"type": "string", "example": "string", "description": "External message identifier from the SMS provider (e.g. Twilio Message SID)."}, "score": {"type": "integer", "format": "int32", "example": 1, "description": "Quality score given to the message by the user (e.g. for AI-suggested replies). Used to feed back into the suggestion engine."}, "status": {"type": "integer", "description": "Delivery status of the message (e.g. Sent, Delivered, Failed).\n\nInteger enum value: 1 - Sending, 2 - Sent, 3 - Failed, 4 - Received, 5 - Seen", "example": 1, "enum": [1, 2, 3, 4, 5]}, "text_message_conversation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the conversation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "attachments": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties."}, "description": "Files attached to the message (e.g. MMS attachments)."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "TextMessageConversation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "phone": {"type": "string", "format": "uri", "description": "Coevera phone number used as the sender side of the conversation.\n\nRelation to Phone. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Phone' object for properties."}, "recipient_account": {"type": "string", "format": "uri", "description": "Account record matched to the recipient phone, when one exists.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "recipient_contact": {"type": "string", "format": "uri", "description": "Contact record matched to the recipient phone, when one exists.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "phone_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sender phone."}, "recipient_account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the matched account."}, "recipient_contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the matched contact."}, "recipient_phone_number": {"type": "string", "example": "string", "description": "External phone number of the conversation recipient. Cannot be changed once the conversation has started."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "messages": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to TextMessage. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TextMessage' object for properties."}, "description": "Messages exchanged in the conversation, ordered by send time."}, "account_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to TextMessageConversationRelations. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TextMessageConversationRelations' object for properties."}, "description": "Accounts linked to this conversation."}, "contact_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to TextMessageConversationRelations. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TextMessageConversationRelations' object for properties."}, "description": "Contacts linked to this conversation."}, "project_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to TextMessageConversationRelations. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TextMessageConversationRelations' object for properties."}, "description": "Projects linked to this conversation."}, "lead_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to TextMessageConversationRelations. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TextMessageConversationRelations' object for properties."}, "description": "Leads linked to this conversation."}, "opportunity_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to TextMessageConversationRelations. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TextMessageConversationRelations' object for properties."}, "description": "Opportunities linked to this conversation."}, "quote_relations": {"type": "array", "items": {"type": "string", "format": "uri", "description": "Relation to TextMessageConversationRelations. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TextMessageConversationRelations' object for properties."}, "description": "Quotes linked to this conversation."}}, "required": ["is_delete_protected", "id", "phone", "phone_id"]}, "createTextMessageConversationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "phone_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sender phone."}, "recipient_account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the matched account."}, "recipient_contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the matched contact."}, "recipient_phone_number": {"type": "string", "example": "string", "description": "External phone number of the conversation recipient. Cannot be changed once the conversation has started."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "messages": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TextMessage, see: 'createTextMessageInput' object for properties."}, "description": "Messages exchanged in the conversation, ordered by send time."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TextMessageConversationRelations, see: 'createTextMessageConversationRelationsInput' object for properties."}, "description": "Accounts linked to this conversation."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TextMessageConversationRelations, see: 'createTextMessageConversationRelationsInput' object for properties."}, "description": "Contacts linked to this conversation."}, "project_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TextMessageConversationRelations, see: 'createTextMessageConversationRelationsInput' object for properties."}, "description": "Projects linked to this conversation."}, "lead_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TextMessageConversationRelations, see: 'createTextMessageConversationRelationsInput' object for properties."}, "description": "Leads linked to this conversation."}, "opportunity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TextMessageConversationRelations, see: 'createTextMessageConversationRelationsInput' object for properties."}, "description": "Opportunities linked to this conversation."}, "quote_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TextMessageConversationRelations, see: 'createTextMessageConversationRelationsInput' object for properties."}, "description": "Quotes linked to this conversation."}}, "required": ["phone_id"]}, "updateTextMessageConversationInput": {"properties": {"phone_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sender phone."}, "recipient_account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the matched account."}, "recipient_contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the matched contact."}, "recipient_phone_number": {"type": "string", "example": "string", "description": "External phone number of the conversation recipient. Cannot be changed once the conversation has started."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "messages": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TextMessage, see: 'updateTextMessageInput' object for properties."}, "description": "Messages exchanged in the conversation, ordered by send time."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties."}, "description": "Accounts linked to this conversation."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties."}, "description": "Contacts linked to this conversation."}, "project_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties."}, "description": "Projects linked to this conversation."}, "lead_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties."}, "description": "Leads linked to this conversation."}, "opportunity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties."}, "description": "Opportunities linked to this conversation."}, "quote_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties."}, "description": "Quotes linked to this conversation."}}}, "batchTextMessageConversationInput": {"properties": {"phone_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the sender phone."}, "recipient_account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the matched account."}, "recipient_contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the matched contact."}, "recipient_phone_number": {"type": "string", "example": "string", "description": "External phone number of the conversation recipient. Cannot be changed once the conversation has started."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "messages": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TextMessage, see: 'updateTextMessageInput' object for properties."}, "description": "Messages exchanged in the conversation, ordered by send time."}, "account_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties."}, "description": "Accounts linked to this conversation."}, "contact_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties."}, "description": "Contacts linked to this conversation."}, "project_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties."}, "description": "Projects linked to this conversation."}, "lead_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties."}, "description": "Leads linked to this conversation."}, "opportunity_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties."}, "description": "Opportunities linked to this conversation."}, "quote_relations": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uri"}}, "description": "Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties."}, "description": "Quotes linked to this conversation."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "TextMessageConversationRelations": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account": {"type": "string", "format": "uri", "description": "Account the conversation is linked to, or empty when not linked.\n\nRelation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties."}, "contact": {"type": "string", "format": "uri", "description": "Contact the conversation is linked to, or empty when not linked.\n\nRelation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties."}, "lead": {"type": "string", "format": "uri", "description": "Lead the conversation is linked to. Set when lead_oppty_id resolves to a Lead.\n\nRelation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties."}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity the conversation is linked to. Set when lead_oppty_id resolves to an Opportunity.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "project": {"type": "string", "format": "uri", "description": "Project the conversation is linked to.\n\nRelation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties."}, "quote": {"type": "string", "format": "uri", "description": "Quote the conversation is linked to.\n\nRelation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties."}, "text_message_conversation": {"type": "string", "format": "uri", "description": "Conversation this link belongs to.\n\nRelation to TextMessageConversation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TextMessageConversation' object for properties."}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity the conversation is linked to, or empty when not linked."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project, or empty when not linked."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote, or empty when not linked."}, "text_message_conversation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the conversation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id", "text_message_conversation", "text_message_conversation_id"]}, "createTextMessageConversationRelationsInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity the conversation is linked to, or empty when not linked."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project, or empty when not linked."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote, or empty when not linked."}, "text_message_conversation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the conversation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["text_message_conversation_id"]}, "updateTextMessageConversationRelationsInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity the conversation is linked to, or empty when not linked."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project, or empty when not linked."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote, or empty when not linked."}, "text_message_conversation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the conversation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchTextMessageConversationRelationsInput": {"properties": {"account_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked account."}, "contact_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked contact."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity the conversation is linked to, or empty when not linked."}, "project_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked project, or empty when not linked."}, "quote_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the linked quote, or empty when not linked."}, "text_message_conversation_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the conversation."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Timeframe": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "lead": {"type": "string", "format": "uri", "description": "Lead this step-time record belongs to. Set when lead_oppty_id resolves to a Lead.\n\nRelation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties."}, "oppty": {"type": "string", "format": "uri", "description": "Opportunity this step-time record belongs to. Set when lead_oppty_id resolves to an Opportunity.\n\nRelation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties."}, "step": {"type": "string", "format": "uri", "description": "Pipeline step the lead/opportunity entered.\n\nRelation to Step. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Step' object for properties."}, "lead_oppty_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead or opportunity the timeframe belongs to."}, "step_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the pipeline step."}, "timeframe": {"type": "integer", "format": "int32", "example": 1, "description": "Number of seconds the record spent in the step (cumulative across re-entries)."}}, "required": ["is_delete_protected", "id", "step", "lead_oppty_id", "step_id", "timeframe"]}, "Translation": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "has_draft": {"type": "boolean", "example": false, "description": "Set to True if draft for entity exists and can be published"}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_type": {"type": "string", "format": "uri", "description": "Account type the form-level translation applies to.\n\nRelation to AccountType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountType' object for properties."}, "appointment_type": {"type": "string", "format": "uri", "description": "Appointment type the form-level translation applies to.\n\nRelation to AppointmentType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentType' object for properties."}, "contact_type": {"type": "string", "format": "uri", "description": "Contact type the form-level translation applies to.\n\nRelation to ContactType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactType' object for properties."}, "data": {"type": "string", "format": "uri", "description": "Data option (dropdown/radio choice) this row translates. Set when label_type is Data.\n\nRelation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties."}, "field": {"type": "string", "format": "uri", "description": "Field whose name/label this row translates. Set when label_type is Field, FormField, or FormDescription.\n\nRelation to Field. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Field' object for properties."}, "lead_type": {"type": "string", "format": "uri", "description": "Lead type the form-level translation applies to.\n\nRelation to LeadType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadType' object for properties."}, "oppty_product_relation_type": {"type": "string", "format": "uri", "description": "Opportunity product relation type the form-level translation applies to.\n\nRelation to OpptyProductRelationType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelationType' object for properties."}, "oppty_type": {"type": "string", "format": "uri", "description": "Opportunity type the form-level translation applies to.\n\nRelation to OpportunityType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpportunityType' object for properties."}, "product_type": {"type": "string", "format": "uri", "description": "Product type the form-level translation applies to.\n\nRelation to ProductType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProductType' object for properties."}, "project_type": {"type": "string", "format": "uri", "description": "Project type the form-level translation applies to.\n\nRelation to ProjectType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProjectType' object for properties."}, "task_type": {"type": "string", "format": "uri", "description": "Task type the form-level translation applies to.\n\nRelation to TaskType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TaskType' object for properties."}, "account_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account type."}, "appointment_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment type."}, "contact_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact type."}, "data_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the translated data option."}, "de_de": {"type": "string", "example": "string", "description": "Translated text in German."}, "en_us": {"type": "string", "example": "string", "description": "Translated text in US English."}, "es_es": {"type": "string", "example": "string", "description": "Translated text in Spanish."}, "field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the translated field."}, "form_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Edit, 1 - Lost", "example": 0, "enum": [0, 1]}, "label_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Field, 1 - Data, 2 - FormField, 3 - FormDescription", "example": 0, "enum": [0, 1, 2, 3]}, "lead_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead type."}, "oppty_product_relation_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity product relation type."}, "oppty_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity type."}, "product_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product type."}, "project_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project type."}, "pt_br": {"type": "string", "example": "string", "description": "Translated text in Brazilian Portuguese."}, "task_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the task type."}, "is_published": {"type": "boolean", "example": false, "description": "True when the translation is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "has_draft", "id", "label_type"]}, "createTranslationInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "account_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account type."}, "appointment_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment type."}, "contact_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact type."}, "data_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the translated data option."}, "de_de": {"type": "string", "example": "string", "description": "Translated text in German."}, "en_us": {"type": "string", "example": "string", "description": "Translated text in US English."}, "es_es": {"type": "string", "example": "string", "description": "Translated text in Spanish."}, "field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the translated field."}, "form_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Edit, 1 - Lost", "example": 0, "enum": [0, 1]}, "label_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Field, 1 - Data, 2 - FormField, 3 - FormDescription", "example": 0, "enum": [0, 1, 2, 3]}, "lead_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead type."}, "oppty_product_relation_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity product relation type."}, "oppty_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity type."}, "product_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product type."}, "project_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project type."}, "pt_br": {"type": "string", "example": "string", "description": "Translated text in Brazilian Portuguese."}, "task_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the task type."}, "is_published": {"type": "boolean", "example": false, "description": "True when the translation is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["label_type"]}, "updateTranslationInput": {"properties": {"account_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account type."}, "appointment_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment type."}, "contact_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact type."}, "data_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the translated data option."}, "de_de": {"type": "string", "example": "string", "description": "Translated text in German."}, "en_us": {"type": "string", "example": "string", "description": "Translated text in US English."}, "es_es": {"type": "string", "example": "string", "description": "Translated text in Spanish."}, "field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the translated field."}, "form_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Edit, 1 - Lost", "example": 0, "enum": [0, 1]}, "label_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Field, 1 - Data, 2 - FormField, 3 - FormDescription", "example": 0, "enum": [0, 1, 2, 3]}, "lead_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead type."}, "oppty_product_relation_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity product relation type."}, "oppty_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity type."}, "product_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product type."}, "project_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project type."}, "pt_br": {"type": "string", "example": "string", "description": "Translated text in Brazilian Portuguese."}, "task_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the task type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchTranslationInput": {"properties": {"account_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the account type."}, "appointment_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the appointment type."}, "contact_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the contact type."}, "data_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the translated data option."}, "de_de": {"type": "string", "example": "string", "description": "Translated text in German."}, "en_us": {"type": "string", "example": "string", "description": "Translated text in US English."}, "es_es": {"type": "string", "example": "string", "description": "Translated text in Spanish."}, "field_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the translated field."}, "form_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Edit, 1 - Lost", "example": 0, "enum": [0, 1]}, "label_type": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - Field, 1 - Data, 2 - FormField, 3 - FormDescription", "example": 0, "enum": [0, 1, 2, 3]}, "lead_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the lead type."}, "oppty_product_relation_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity product relation type."}, "oppty_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the opportunity type."}, "product_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the product type."}, "project_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the project type."}, "pt_br": {"type": "string", "example": "string", "description": "Translated text in Brazilian Portuguese."}, "task_type_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the task type."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Type": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "example": "string", "description": "Unique identifier of entity.", "readOnly": true}, "primitive_type": {"type": "string", "example": "blob", "enum": ["blob", "bool", "date", "datetime", "decimal", "double", "dynamic", "enum", "int", "list", "object", "string", "uuid", "tsvector"], "description": "Field whose values are strictly defined with an enumeration of values.", "readOnly": true}, "validator": {"type": "object", "description": "Validation rules applied to values of this type (e.g. max length, regex, allowed enum values), as a JSON document.", "readOnly": true}, "flag": {"type": "integer", "format": "int32", "example": 1, "description": "This field is bit flag which determinate purpose of the field and his abilities on form, following options are allowed\n            CUSTOM_ALLOWED = 1  # field of this type can be created as new custom field\n            CALC_ALLOWED = 2  # field can have calculation formula defined\n            DEFAULT_ALLOWED = 4  # field can have default value defined\n            MOBILE_ALLOWED = 8  # field can be displayed on form \n            FIELD_MAP_REQUIRED = 16  # Obsolete\n            FORM_FORBIDDEN = 32  # field of this type can't be located on form\n            READONLY_ALLOWED = 64  # field can be defined as readonly on form\n            ONLY_MAIN_FORM = 128  # field can be only at FORM_EDIT form not on e.g FORM_LOST \n            ALLOWED_IN_CALC_FORMULA = 256  # field can be used within calculation expression\n            MUST_BE_ON_FORM = 512 # field of this type can't be removed from form", "readOnly": true}, "default_value": {"type": "string", "example": "string", "description": "Default value applied to fields of this type when no value is supplied at create-time. Empty when the type has no default.", "readOnly": true}, "relation_type": {"type": "integer", "description": "Cardinality of the relation when the type represents a relation (e.g. one-to-one, many-to-one).\n\nInteger enum value: 0 - NO_RELATION, 1 - MANY_TO_ONE_SCALAR, 2 - MANY_TO_MANY_VECTOR", "example": 0, "enum": [0, 1, 2], "readOnly": true}, "container_size": {"type": "integer", "format": "int32", "example": 1, "description": "Maximum length or capacity for fields of this type (e.g. string max-length).", "readOnly": true}, "is_groupable": {"type": "boolean", "example": false, "description": "True when fields of this type can be used as a grouping column in reports.", "readOnly": true}, "is_filterable": {"type": "boolean", "example": false, "description": "True when fields of this type can be used in filters.", "readOnly": true}, "is_sortable": {"type": "boolean", "example": false, "description": "True when fields of this type can be used to sort records.", "readOnly": true}, "is_selectable": {"type": "boolean", "example": false, "description": "True when fields of this type can be selected in queries.", "readOnly": true}}, "required": ["is_delete_protected", "id", "primitive_type", "flag", "relation_type", "container_size", "is_groupable", "is_filterable", "is_sortable", "is_selectable"]}, "UnsubscribedPhone": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "phone": {"type": "string", "example": "string", "description": "Phone number that has unsubscribed from receiving SMS messages, in E.164 format."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "id"]}, "createUnsubscribedPhoneInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "phone": {"type": "string", "example": "string", "description": "Phone number that has unsubscribed from receiving SMS messages, in E.164 format."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "updateUnsubscribedPhoneInput": {"properties": {"phone": {"type": "string", "example": "string", "description": "Phone number that has unsubscribed from receiving SMS messages, in E.164 format."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchUnsubscribedPhoneInput": {"properties": {"phone": {"type": "string", "example": "string", "description": "Phone number that has unsubscribed from receiving SMS messages, in E.164 format."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Webhook": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "application": {"type": "string", "format": "uri", "description": "OAuth application that registered this webhook. Set automatically when the webhook is created using OAuth credentials; empty when a team-space API key was used.\n\nRelation to Application. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Application' object for properties.", "readOnly": true}, "client": {"type": "string", "format": "uri", "description": "Client who defined the Webhook. Only those notifications are sent which this Client has permission to see. If empty, all space notification are send, even for events of private records. Value is automatically set to authenticated user who created the webhook. It is left empty if global team space API Credentials are used.\n\nRelation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties."}, "application_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the OAuth application that registered the Webhook.", "readOnly": true}, "client_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the user who defined the Webhook."}, "insecure_ssl": {"type": "boolean", "example": false, "description": "If True, remote side ssl certificate will not be validated when delivering notifications."}, "options": {"type": "object", "description": "Params in REST API format (snake case), to modify the content of the WebHook.\nYou can set \"entity\" options of the main entity on which the event occurs.\nE.g. Account for events like Account.Create, Account.Update, Account.Delete.\nFor events with a secondary related entity you can also options under key \"related_entity\".\nE.g. for Account.LinkedDocument event, the \"expand\" option of CloudObject(Document)\ncan be set under \"related_entity\" key.\nFilter follows REST API conventions:\nhttp://pipeliner-api-doc.s3-website-eu-west-1.amazonaws.com/latest/rest/space/index.html\nIn addition, to REST params, you can conditionally trigger webhook\nonly when specified fields will change. You can use \"on-field-change\" param and provide\na list of api names on which this change will listen. The \"on-field-change\" option is available for Account,\nAppointment, Task, Contact, Opportunity, Lead, Product Line Item, Project, Quote and Custom Entity.\n\nSuppressing Webhooks\nYou can specify list of strings under \"skip_keys\" key in options.\nWhenever you make an API request with header \"Webhook-Skip-Key\"\nequal to any of the specified skip keys,\nthe Webhook will not be triggered. This can prevent a Webhook loop.\n\nExample:\n{\n    \"entity\": {\n        \"Contact\": {\n            \"expand\": [\n                \"primary_account\",\n                \"primary_contact\",\n                \"task_relations.task\"\n            ],\n            \"load-only\": [\n                \"id\",\n                \"primary_account\",\n                \"primary_contact.first_name\",\n                \"task_relations.task\"\n            ],\n            \"filter\": {\n                \"email1\":  [\"test@example.com\", \"test@example.net\"],\n                \"email2\":  \"test@example.com\"\n            },\n            \"filter-op\": {\"email1\":  \"eq\"},  # optional, default operator is eq\n            \"on-field-change\": [\"email1\"]\n        },\n        \"Account\": {\n            \"filter\": {\n                \"owner_id\":  [\"9900cce6-bcd6-412a-bcd1-1904556c949a\"]\n            }\n        }\n    },\n    \"related_entity\": {\"expand\": [\"contact\"], \"load-only\": [\"id\", \"contact\"]},\n    \"skip_keys\": [\"gmail_sync\", \"custom_integration\"],\n    \"chunk_size\": 100, // defines the size of the chunk, default is 100, max is 100.\n    \"chunk_delay\": 300, // each chunk will be delayed by N * chunk_delay seconds, where N is index of chunk, default is 0.\n    \"custom_entity_api_name\": [\"CE_Name1\", \"CE_Name2\"] // in case of triggered custom entity, this will execute webhooks only for specified ones within the list. Default are all custom entity types.\n}"}, "signature": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Signature to verify webhook (has to be UUID). When signature is set, then all webhook requests will be signed using HMAC-SHA256. This signature will be used as key and request body as message. Signature will be located in \"WebHook-Signature\" header."}, "url": {"type": "string", "example": "string", "description": "Target URL that webhook event payloads are POSTed to."}, "events": {"type": "array", "items": {"type": "string", "example": "*", "enum": ["*", "Account.*", "Account.Create", "Account.Delete", "Account.DocumentLinked", "Account.OwnerChanged", "Account.Update", "ActivityRelation.*", "ActivityRelation.Create", "ActivityRelation.Delete", "ActivityRelation.Update", "Appointment.*", "Appointment.Comment", "Appointment.Create", "Appointment.Delete", "Appointment.DocumentLinked", "Appointment.OwnerChanged", "Appointment.Update", "Contact.*", "Contact.Create", "Contact.Delete", "Contact.DocumentLinked", "Contact.OwnerChanged", "Contact.Update", "ContactAccountRelation.*", "ContactAccountRelation.Create", "ContactAccountRelation.Delete", "ContactAccountRelation.Update", "Currency.*", "Currency.Create", "Currency.Delete", "Currency.Update", "CurrencyExchangeRate.*", "CurrencyExchangeRate.Create", "CurrencyExchangeRate.Delete", "CurrencyExchangeRate.Update", "CurrencyExchangeRatesList.*", "CurrencyExchangeRatesList.Create", "CurrencyExchangeRatesList.Delete", "CurrencyExchangeRatesList.Update", "CustomEntity.*", "CustomEntity.Create", "CustomEntity.Delete", "CustomEntity.DocumentLinked", "CustomEntity.OwnerChanged", "CustomEntity.Update", "Email.*", "Email.Create", "Email.Delete", "Email.DocumentLinked", "Email.Update", "Lead.*", "Lead.BackToLead", "Lead.Create", "Lead.Delete", "Lead.DocumentLinked", "Lead.Lost", "Lead.OwnerChanged", "Lead.Update", "LeadOpptyAccountRelation.*", "LeadOpptyAccountRelation.Create", "LeadOpptyAccountRelation.Delete", "LeadOpptyAccountRelation.Update", "LeadOpptyContactRelation.*", "LeadOpptyContactRelation.Create", "LeadOpptyContactRelation.Delete", "LeadOpptyContactRelation.Update", "Memo.*", "Memo.Comment", "Memo.Create", "Memo.Delete", "Memo.DocumentLinked", "Memo.Update", "Message.*", "Message.Create", "Message.Delete", "Message.DocumentLinked", "Message.Update", "Note.*", "Note.Create", "Note.Delete", "Note.Update", "Opportunity.*", "Opportunity.Create", "Opportunity.Delete", "Opportunity.DocumentLinked", "Opportunity.Lost", "Opportunity.Move", "Opportunity.OwnerChanged", "Opportunity.Qualify", "Opportunity.Update", "Opportunity.Won", "OpptyProductRelation.*", "OpptyProductRelation.Create", "OpptyProductRelation.Delete", "OpptyProductRelation.Update", "Product.*", "Product.Create", "Product.Delete", "Product.Update", "ProductPriceList.*", "ProductPriceList.Create", "ProductPriceList.Delete", "ProductPriceList.Update", "ProductPriceListPrice.*", "ProductPriceListPrice.Create", "ProductPriceListPrice.Delete", "ProductPriceListPrice.Update", "Project.*", "Project.Create", "Project.Delete", "Project.DocumentLinked", "Project.OwnerChanged", "Project.Update", "Quote.*", "Quote.Create", "Quote.Delete", "Quote.DocumentLinked", "Quote.Lost", "Quote.Move", "Quote.OwnerChanged", "Quote.Update", "Quote.Won", "QuoteAccountRelation.*", "QuoteAccountRelation.Create", "QuoteAccountRelation.Delete", "QuoteAccountRelation.Update", "QuoteContactRelation.*", "QuoteContactRelation.Create", "QuoteContactRelation.Delete", "QuoteContactRelation.Update", "Task.*", "Task.Comment", "Task.Create", "Task.Delete", "Task.DocumentLinked", "Task.OwnerChanged", "Task.Update"]}, "description": "Event types this webhook subscribes to (e.g. Account.Create, Lead.Update). At least one event is required; the webhook fires whenever any subscribed event occurs in the team space."}}, "required": ["is_delete_protected", "id", "insecure_ssl", "url", "events"]}, "createWebhookInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "insecure_ssl": {"type": "boolean", "example": false, "description": "If True, remote side ssl certificate will not be validated when delivering notifications."}, "options": {"type": "object", "description": "Params in REST API format (snake case), to modify the content of the WebHook.\nYou can set \"entity\" options of the main entity on which the event occurs.\nE.g. Account for events like Account.Create, Account.Update, Account.Delete.\nFor events with a secondary related entity you can also options under key \"related_entity\".\nE.g. for Account.LinkedDocument event, the \"expand\" option of CloudObject(Document)\ncan be set under \"related_entity\" key.\nFilter follows REST API conventions:\nhttp://pipeliner-api-doc.s3-website-eu-west-1.amazonaws.com/latest/rest/space/index.html\nIn addition, to REST params, you can conditionally trigger webhook\nonly when specified fields will change. You can use \"on-field-change\" param and provide\na list of api names on which this change will listen. The \"on-field-change\" option is available for Account,\nAppointment, Task, Contact, Opportunity, Lead, Product Line Item, Project, Quote and Custom Entity.\n\nSuppressing Webhooks\nYou can specify list of strings under \"skip_keys\" key in options.\nWhenever you make an API request with header \"Webhook-Skip-Key\"\nequal to any of the specified skip keys,\nthe Webhook will not be triggered. This can prevent a Webhook loop.\n\nExample:\n{\n    \"entity\": {\n        \"Contact\": {\n            \"expand\": [\n                \"primary_account\",\n                \"primary_contact\",\n                \"task_relations.task\"\n            ],\n            \"load-only\": [\n                \"id\",\n                \"primary_account\",\n                \"primary_contact.first_name\",\n                \"task_relations.task\"\n            ],\n            \"filter\": {\n                \"email1\":  [\"test@example.com\", \"test@example.net\"],\n                \"email2\":  \"test@example.com\"\n            },\n            \"filter-op\": {\"email1\":  \"eq\"},  # optional, default operator is eq\n            \"on-field-change\": [\"email1\"]\n        },\n        \"Account\": {\n            \"filter\": {\n                \"owner_id\":  [\"9900cce6-bcd6-412a-bcd1-1904556c949a\"]\n            }\n        }\n    },\n    \"related_entity\": {\"expand\": [\"contact\"], \"load-only\": [\"id\", \"contact\"]},\n    \"skip_keys\": [\"gmail_sync\", \"custom_integration\"],\n    \"chunk_size\": 100, // defines the size of the chunk, default is 100, max is 100.\n    \"chunk_delay\": 300, // each chunk will be delayed by N * chunk_delay seconds, where N is index of chunk, default is 0.\n    \"custom_entity_api_name\": [\"CE_Name1\", \"CE_Name2\"] // in case of triggered custom entity, this will execute webhooks only for specified ones within the list. Default are all custom entity types.\n}"}, "signature": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Signature to verify webhook (has to be UUID). When signature is set, then all webhook requests will be signed using HMAC-SHA256. This signature will be used as key and request body as message. Signature will be located in \"WebHook-Signature\" header."}, "url": {"type": "string", "example": "string", "description": "Target URL that webhook event payloads are POSTed to."}, "events": {"type": "array", "items": {"type": "string", "example": "*", "enum": ["*", "Account.*", "Account.Create", "Account.Delete", "Account.DocumentLinked", "Account.OwnerChanged", "Account.Update", "ActivityRelation.*", "ActivityRelation.Create", "ActivityRelation.Delete", "ActivityRelation.Update", "Appointment.*", "Appointment.Comment", "Appointment.Create", "Appointment.Delete", "Appointment.DocumentLinked", "Appointment.OwnerChanged", "Appointment.Update", "Contact.*", "Contact.Create", "Contact.Delete", "Contact.DocumentLinked", "Contact.OwnerChanged", "Contact.Update", "ContactAccountRelation.*", "ContactAccountRelation.Create", "ContactAccountRelation.Delete", "ContactAccountRelation.Update", "Currency.*", "Currency.Create", "Currency.Delete", "Currency.Update", "CurrencyExchangeRate.*", "CurrencyExchangeRate.Create", "CurrencyExchangeRate.Delete", "CurrencyExchangeRate.Update", "CurrencyExchangeRatesList.*", "CurrencyExchangeRatesList.Create", "CurrencyExchangeRatesList.Delete", "CurrencyExchangeRatesList.Update", "CustomEntity.*", "CustomEntity.Create", "CustomEntity.Delete", "CustomEntity.DocumentLinked", "CustomEntity.OwnerChanged", "CustomEntity.Update", "Email.*", "Email.Create", "Email.Delete", "Email.DocumentLinked", "Email.Update", "Lead.*", "Lead.BackToLead", "Lead.Create", "Lead.Delete", "Lead.DocumentLinked", "Lead.Lost", "Lead.OwnerChanged", "Lead.Update", "LeadOpptyAccountRelation.*", "LeadOpptyAccountRelation.Create", "LeadOpptyAccountRelation.Delete", "LeadOpptyAccountRelation.Update", "LeadOpptyContactRelation.*", "LeadOpptyContactRelation.Create", "LeadOpptyContactRelation.Delete", "LeadOpptyContactRelation.Update", "Memo.*", "Memo.Comment", "Memo.Create", "Memo.Delete", "Memo.DocumentLinked", "Memo.Update", "Message.*", "Message.Create", "Message.Delete", "Message.DocumentLinked", "Message.Update", "Note.*", "Note.Create", "Note.Delete", "Note.Update", "Opportunity.*", "Opportunity.Create", "Opportunity.Delete", "Opportunity.DocumentLinked", "Opportunity.Lost", "Opportunity.Move", "Opportunity.OwnerChanged", "Opportunity.Qualify", "Opportunity.Update", "Opportunity.Won", "OpptyProductRelation.*", "OpptyProductRelation.Create", "OpptyProductRelation.Delete", "OpptyProductRelation.Update", "Product.*", "Product.Create", "Product.Delete", "Product.Update", "ProductPriceList.*", "ProductPriceList.Create", "ProductPriceList.Delete", "ProductPriceList.Update", "ProductPriceListPrice.*", "ProductPriceListPrice.Create", "ProductPriceListPrice.Delete", "ProductPriceListPrice.Update", "Project.*", "Project.Create", "Project.Delete", "Project.DocumentLinked", "Project.OwnerChanged", "Project.Update", "Quote.*", "Quote.Create", "Quote.Delete", "Quote.DocumentLinked", "Quote.Lost", "Quote.Move", "Quote.OwnerChanged", "Quote.Update", "Quote.Won", "QuoteAccountRelation.*", "QuoteAccountRelation.Create", "QuoteAccountRelation.Delete", "QuoteAccountRelation.Update", "QuoteContactRelation.*", "QuoteContactRelation.Create", "QuoteContactRelation.Delete", "QuoteContactRelation.Update", "Task.*", "Task.Comment", "Task.Create", "Task.Delete", "Task.DocumentLinked", "Task.OwnerChanged", "Task.Update"]}, "description": "Event types this webhook subscribes to (e.g. Account.Create, Lead.Update). At least one event is required; the webhook fires whenever any subscribed event occurs in the team space."}}, "required": ["insecure_ssl", "url", "events"]}, "updateWebhookInput": {"properties": {"insecure_ssl": {"type": "boolean", "example": false, "description": "If True, remote side ssl certificate will not be validated when delivering notifications."}, "options": {"type": "object", "description": "Params in REST API format (snake case), to modify the content of the WebHook.\nYou can set \"entity\" options of the main entity on which the event occurs.\nE.g. Account for events like Account.Create, Account.Update, Account.Delete.\nFor events with a secondary related entity you can also options under key \"related_entity\".\nE.g. for Account.LinkedDocument event, the \"expand\" option of CloudObject(Document)\ncan be set under \"related_entity\" key.\nFilter follows REST API conventions:\nhttp://pipeliner-api-doc.s3-website-eu-west-1.amazonaws.com/latest/rest/space/index.html\nIn addition, to REST params, you can conditionally trigger webhook\nonly when specified fields will change. You can use \"on-field-change\" param and provide\na list of api names on which this change will listen. The \"on-field-change\" option is available for Account,\nAppointment, Task, Contact, Opportunity, Lead, Product Line Item, Project, Quote and Custom Entity.\n\nSuppressing Webhooks\nYou can specify list of strings under \"skip_keys\" key in options.\nWhenever you make an API request with header \"Webhook-Skip-Key\"\nequal to any of the specified skip keys,\nthe Webhook will not be triggered. This can prevent a Webhook loop.\n\nExample:\n{\n    \"entity\": {\n        \"Contact\": {\n            \"expand\": [\n                \"primary_account\",\n                \"primary_contact\",\n                \"task_relations.task\"\n            ],\n            \"load-only\": [\n                \"id\",\n                \"primary_account\",\n                \"primary_contact.first_name\",\n                \"task_relations.task\"\n            ],\n            \"filter\": {\n                \"email1\":  [\"test@example.com\", \"test@example.net\"],\n                \"email2\":  \"test@example.com\"\n            },\n            \"filter-op\": {\"email1\":  \"eq\"},  # optional, default operator is eq\n            \"on-field-change\": [\"email1\"]\n        },\n        \"Account\": {\n            \"filter\": {\n                \"owner_id\":  [\"9900cce6-bcd6-412a-bcd1-1904556c949a\"]\n            }\n        }\n    },\n    \"related_entity\": {\"expand\": [\"contact\"], \"load-only\": [\"id\", \"contact\"]},\n    \"skip_keys\": [\"gmail_sync\", \"custom_integration\"],\n    \"chunk_size\": 100, // defines the size of the chunk, default is 100, max is 100.\n    \"chunk_delay\": 300, // each chunk will be delayed by N * chunk_delay seconds, where N is index of chunk, default is 0.\n    \"custom_entity_api_name\": [\"CE_Name1\", \"CE_Name2\"] // in case of triggered custom entity, this will execute webhooks only for specified ones within the list. Default are all custom entity types.\n}"}, "signature": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Signature to verify webhook (has to be UUID). When signature is set, then all webhook requests will be signed using HMAC-SHA256. This signature will be used as key and request body as message. Signature will be located in \"WebHook-Signature\" header."}, "url": {"type": "string", "example": "string", "description": "Target URL that webhook event payloads are POSTed to."}, "events": {"type": "array", "items": {"type": "string", "example": "*", "enum": ["*", "Account.*", "Account.Create", "Account.Delete", "Account.DocumentLinked", "Account.OwnerChanged", "Account.Update", "ActivityRelation.*", "ActivityRelation.Create", "ActivityRelation.Delete", "ActivityRelation.Update", "Appointment.*", "Appointment.Comment", "Appointment.Create", "Appointment.Delete", "Appointment.DocumentLinked", "Appointment.OwnerChanged", "Appointment.Update", "Contact.*", "Contact.Create", "Contact.Delete", "Contact.DocumentLinked", "Contact.OwnerChanged", "Contact.Update", "ContactAccountRelation.*", "ContactAccountRelation.Create", "ContactAccountRelation.Delete", "ContactAccountRelation.Update", "Currency.*", "Currency.Create", "Currency.Delete", "Currency.Update", "CurrencyExchangeRate.*", "CurrencyExchangeRate.Create", "CurrencyExchangeRate.Delete", "CurrencyExchangeRate.Update", "CurrencyExchangeRatesList.*", "CurrencyExchangeRatesList.Create", "CurrencyExchangeRatesList.Delete", "CurrencyExchangeRatesList.Update", "CustomEntity.*", "CustomEntity.Create", "CustomEntity.Delete", "CustomEntity.DocumentLinked", "CustomEntity.OwnerChanged", "CustomEntity.Update", "Email.*", "Email.Create", "Email.Delete", "Email.DocumentLinked", "Email.Update", "Lead.*", "Lead.BackToLead", "Lead.Create", "Lead.Delete", "Lead.DocumentLinked", "Lead.Lost", "Lead.OwnerChanged", "Lead.Update", "LeadOpptyAccountRelation.*", "LeadOpptyAccountRelation.Create", "LeadOpptyAccountRelation.Delete", "LeadOpptyAccountRelation.Update", "LeadOpptyContactRelation.*", "LeadOpptyContactRelation.Create", "LeadOpptyContactRelation.Delete", "LeadOpptyContactRelation.Update", "Memo.*", "Memo.Comment", "Memo.Create", "Memo.Delete", "Memo.DocumentLinked", "Memo.Update", "Message.*", "Message.Create", "Message.Delete", "Message.DocumentLinked", "Message.Update", "Note.*", "Note.Create", "Note.Delete", "Note.Update", "Opportunity.*", "Opportunity.Create", "Opportunity.Delete", "Opportunity.DocumentLinked", "Opportunity.Lost", "Opportunity.Move", "Opportunity.OwnerChanged", "Opportunity.Qualify", "Opportunity.Update", "Opportunity.Won", "OpptyProductRelation.*", "OpptyProductRelation.Create", "OpptyProductRelation.Delete", "OpptyProductRelation.Update", "Product.*", "Product.Create", "Product.Delete", "Product.Update", "ProductPriceList.*", "ProductPriceList.Create", "ProductPriceList.Delete", "ProductPriceList.Update", "ProductPriceListPrice.*", "ProductPriceListPrice.Create", "ProductPriceListPrice.Delete", "ProductPriceListPrice.Update", "Project.*", "Project.Create", "Project.Delete", "Project.DocumentLinked", "Project.OwnerChanged", "Project.Update", "Quote.*", "Quote.Create", "Quote.Delete", "Quote.DocumentLinked", "Quote.Lost", "Quote.Move", "Quote.OwnerChanged", "Quote.Update", "Quote.Won", "QuoteAccountRelation.*", "QuoteAccountRelation.Create", "QuoteAccountRelation.Delete", "QuoteAccountRelation.Update", "QuoteContactRelation.*", "QuoteContactRelation.Create", "QuoteContactRelation.Delete", "QuoteContactRelation.Update", "Task.*", "Task.Comment", "Task.Create", "Task.Delete", "Task.DocumentLinked", "Task.OwnerChanged", "Task.Update"]}, "description": "Event types this webhook subscribes to (e.g. Account.Create, Lead.Update). At least one event is required; the webhook fires whenever any subscribed event occurs in the team space."}}}, "batchWebhookInput": {"properties": {"insecure_ssl": {"type": "boolean", "example": false, "description": "If True, remote side ssl certificate will not be validated when delivering notifications."}, "options": {"type": "object", "description": "Params in REST API format (snake case), to modify the content of the WebHook.\nYou can set \"entity\" options of the main entity on which the event occurs.\nE.g. Account for events like Account.Create, Account.Update, Account.Delete.\nFor events with a secondary related entity you can also options under key \"related_entity\".\nE.g. for Account.LinkedDocument event, the \"expand\" option of CloudObject(Document)\ncan be set under \"related_entity\" key.\nFilter follows REST API conventions:\nhttp://pipeliner-api-doc.s3-website-eu-west-1.amazonaws.com/latest/rest/space/index.html\nIn addition, to REST params, you can conditionally trigger webhook\nonly when specified fields will change. You can use \"on-field-change\" param and provide\na list of api names on which this change will listen. The \"on-field-change\" option is available for Account,\nAppointment, Task, Contact, Opportunity, Lead, Product Line Item, Project, Quote and Custom Entity.\n\nSuppressing Webhooks\nYou can specify list of strings under \"skip_keys\" key in options.\nWhenever you make an API request with header \"Webhook-Skip-Key\"\nequal to any of the specified skip keys,\nthe Webhook will not be triggered. This can prevent a Webhook loop.\n\nExample:\n{\n    \"entity\": {\n        \"Contact\": {\n            \"expand\": [\n                \"primary_account\",\n                \"primary_contact\",\n                \"task_relations.task\"\n            ],\n            \"load-only\": [\n                \"id\",\n                \"primary_account\",\n                \"primary_contact.first_name\",\n                \"task_relations.task\"\n            ],\n            \"filter\": {\n                \"email1\":  [\"test@example.com\", \"test@example.net\"],\n                \"email2\":  \"test@example.com\"\n            },\n            \"filter-op\": {\"email1\":  \"eq\"},  # optional, default operator is eq\n            \"on-field-change\": [\"email1\"]\n        },\n        \"Account\": {\n            \"filter\": {\n                \"owner_id\":  [\"9900cce6-bcd6-412a-bcd1-1904556c949a\"]\n            }\n        }\n    },\n    \"related_entity\": {\"expand\": [\"contact\"], \"load-only\": [\"id\", \"contact\"]},\n    \"skip_keys\": [\"gmail_sync\", \"custom_integration\"],\n    \"chunk_size\": 100, // defines the size of the chunk, default is 100, max is 100.\n    \"chunk_delay\": 300, // each chunk will be delayed by N * chunk_delay seconds, where N is index of chunk, default is 0.\n    \"custom_entity_api_name\": [\"CE_Name1\", \"CE_Name2\"] // in case of triggered custom entity, this will execute webhooks only for specified ones within the list. Default are all custom entity types.\n}"}, "signature": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Signature to verify webhook (has to be UUID). When signature is set, then all webhook requests will be signed using HMAC-SHA256. This signature will be used as key and request body as message. Signature will be located in \"WebHook-Signature\" header."}, "url": {"type": "string", "example": "string", "description": "Target URL that webhook event payloads are POSTed to."}, "events": {"type": "array", "items": {"type": "string", "example": "*", "enum": ["*", "Account.*", "Account.Create", "Account.Delete", "Account.DocumentLinked", "Account.OwnerChanged", "Account.Update", "ActivityRelation.*", "ActivityRelation.Create", "ActivityRelation.Delete", "ActivityRelation.Update", "Appointment.*", "Appointment.Comment", "Appointment.Create", "Appointment.Delete", "Appointment.DocumentLinked", "Appointment.OwnerChanged", "Appointment.Update", "Contact.*", "Contact.Create", "Contact.Delete", "Contact.DocumentLinked", "Contact.OwnerChanged", "Contact.Update", "ContactAccountRelation.*", "ContactAccountRelation.Create", "ContactAccountRelation.Delete", "ContactAccountRelation.Update", "Currency.*", "Currency.Create", "Currency.Delete", "Currency.Update", "CurrencyExchangeRate.*", "CurrencyExchangeRate.Create", "CurrencyExchangeRate.Delete", "CurrencyExchangeRate.Update", "CurrencyExchangeRatesList.*", "CurrencyExchangeRatesList.Create", "CurrencyExchangeRatesList.Delete", "CurrencyExchangeRatesList.Update", "CustomEntity.*", "CustomEntity.Create", "CustomEntity.Delete", "CustomEntity.DocumentLinked", "CustomEntity.OwnerChanged", "CustomEntity.Update", "Email.*", "Email.Create", "Email.Delete", "Email.DocumentLinked", "Email.Update", "Lead.*", "Lead.BackToLead", "Lead.Create", "Lead.Delete", "Lead.DocumentLinked", "Lead.Lost", "Lead.OwnerChanged", "Lead.Update", "LeadOpptyAccountRelation.*", "LeadOpptyAccountRelation.Create", "LeadOpptyAccountRelation.Delete", "LeadOpptyAccountRelation.Update", "LeadOpptyContactRelation.*", "LeadOpptyContactRelation.Create", "LeadOpptyContactRelation.Delete", "LeadOpptyContactRelation.Update", "Memo.*", "Memo.Comment", "Memo.Create", "Memo.Delete", "Memo.DocumentLinked", "Memo.Update", "Message.*", "Message.Create", "Message.Delete", "Message.DocumentLinked", "Message.Update", "Note.*", "Note.Create", "Note.Delete", "Note.Update", "Opportunity.*", "Opportunity.Create", "Opportunity.Delete", "Opportunity.DocumentLinked", "Opportunity.Lost", "Opportunity.Move", "Opportunity.OwnerChanged", "Opportunity.Qualify", "Opportunity.Update", "Opportunity.Won", "OpptyProductRelation.*", "OpptyProductRelation.Create", "OpptyProductRelation.Delete", "OpptyProductRelation.Update", "Product.*", "Product.Create", "Product.Delete", "Product.Update", "ProductPriceList.*", "ProductPriceList.Create", "ProductPriceList.Delete", "ProductPriceList.Update", "ProductPriceListPrice.*", "ProductPriceListPrice.Create", "ProductPriceListPrice.Delete", "ProductPriceListPrice.Update", "Project.*", "Project.Create", "Project.Delete", "Project.DocumentLinked", "Project.OwnerChanged", "Project.Update", "Quote.*", "Quote.Create", "Quote.Delete", "Quote.DocumentLinked", "Quote.Lost", "Quote.Move", "Quote.OwnerChanged", "Quote.Update", "Quote.Won", "QuoteAccountRelation.*", "QuoteAccountRelation.Create", "QuoteAccountRelation.Delete", "QuoteAccountRelation.Update", "QuoteContactRelation.*", "QuoteContactRelation.Create", "QuoteContactRelation.Delete", "QuoteContactRelation.Update", "Task.*", "Task.Comment", "Task.Create", "Task.Delete", "Task.DocumentLinked", "Task.OwnerChanged", "Task.Update"]}, "description": "Event types this webhook subscribes to (e.g. Account.Create, Lead.Update). At least one event is required; the webhook fires whenever any subscribed event occurs in the team space."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "WebhookEvent": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "webhook": {"type": "string", "format": "uri", "description": "Webhook this subscription belongs to. The parent webhook is fired whenever the subscribed event occurs.\n\nRelation to Webhook. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Webhook' object for properties."}, "event": {"type": "string", "example": "*", "enum": ["*", "Account.*", "Account.Create", "Account.Delete", "Account.DocumentLinked", "Account.OwnerChanged", "Account.Update", "ActivityRelation.*", "ActivityRelation.Create", "ActivityRelation.Delete", "ActivityRelation.Update", "Appointment.*", "Appointment.Comment", "Appointment.Create", "Appointment.Delete", "Appointment.DocumentLinked", "Appointment.OwnerChanged", "Appointment.Update", "Contact.*", "Contact.Create", "Contact.Delete", "Contact.DocumentLinked", "Contact.OwnerChanged", "Contact.Update", "ContactAccountRelation.*", "ContactAccountRelation.Create", "ContactAccountRelation.Delete", "ContactAccountRelation.Update", "Currency.*", "Currency.Create", "Currency.Delete", "Currency.Update", "CurrencyExchangeRate.*", "CurrencyExchangeRate.Create", "CurrencyExchangeRate.Delete", "CurrencyExchangeRate.Update", "CurrencyExchangeRatesList.*", "CurrencyExchangeRatesList.Create", "CurrencyExchangeRatesList.Delete", "CurrencyExchangeRatesList.Update", "CustomEntity.*", "CustomEntity.Create", "CustomEntity.Delete", "CustomEntity.DocumentLinked", "CustomEntity.OwnerChanged", "CustomEntity.Update", "Email.*", "Email.Create", "Email.Delete", "Email.DocumentLinked", "Email.Update", "Lead.*", "Lead.BackToLead", "Lead.Create", "Lead.Delete", "Lead.DocumentLinked", "Lead.Lost", "Lead.OwnerChanged", "Lead.Update", "LeadOpptyAccountRelation.*", "LeadOpptyAccountRelation.Create", "LeadOpptyAccountRelation.Delete", "LeadOpptyAccountRelation.Update", "LeadOpptyContactRelation.*", "LeadOpptyContactRelation.Create", "LeadOpptyContactRelation.Delete", "LeadOpptyContactRelation.Update", "Memo.*", "Memo.Comment", "Memo.Create", "Memo.Delete", "Memo.DocumentLinked", "Memo.Update", "Message.*", "Message.Create", "Message.Delete", "Message.DocumentLinked", "Message.Update", "Note.*", "Note.Create", "Note.Delete", "Note.Update", "Opportunity.*", "Opportunity.Create", "Opportunity.Delete", "Opportunity.DocumentLinked", "Opportunity.Lost", "Opportunity.Move", "Opportunity.OwnerChanged", "Opportunity.Qualify", "Opportunity.Update", "Opportunity.Won", "OpptyProductRelation.*", "OpptyProductRelation.Create", "OpptyProductRelation.Delete", "OpptyProductRelation.Update", "Product.*", "Product.Create", "Product.Delete", "Product.Update", "ProductPriceList.*", "ProductPriceList.Create", "ProductPriceList.Delete", "ProductPriceList.Update", "ProductPriceListPrice.*", "ProductPriceListPrice.Create", "ProductPriceListPrice.Delete", "ProductPriceListPrice.Update", "Project.*", "Project.Create", "Project.Delete", "Project.DocumentLinked", "Project.OwnerChanged", "Project.Update", "Quote.*", "Quote.Create", "Quote.Delete", "Quote.DocumentLinked", "Quote.Lost", "Quote.Move", "Quote.OwnerChanged", "Quote.Update", "Quote.Won", "QuoteAccountRelation.*", "QuoteAccountRelation.Create", "QuoteAccountRelation.Delete", "QuoteAccountRelation.Update", "QuoteContactRelation.*", "QuoteContactRelation.Create", "QuoteContactRelation.Delete", "QuoteContactRelation.Update", "Task.*", "Task.Comment", "Task.Create", "Task.Delete", "Task.DocumentLinked", "Task.OwnerChanged", "Task.Update"], "description": "Event type the parent webhook subscribes to (e.g. Account.Create, Lead.Update). The webhook fires whenever an event of this type occurs in the team space."}, "webhook_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent webhook."}}, "required": ["is_delete_protected", "id", "webhook", "event", "webhook_id"]}, "createWebhookEventInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "event": {"type": "string", "example": "*", "enum": ["*", "Account.*", "Account.Create", "Account.Delete", "Account.DocumentLinked", "Account.OwnerChanged", "Account.Update", "ActivityRelation.*", "ActivityRelation.Create", "ActivityRelation.Delete", "ActivityRelation.Update", "Appointment.*", "Appointment.Comment", "Appointment.Create", "Appointment.Delete", "Appointment.DocumentLinked", "Appointment.OwnerChanged", "Appointment.Update", "Contact.*", "Contact.Create", "Contact.Delete", "Contact.DocumentLinked", "Contact.OwnerChanged", "Contact.Update", "ContactAccountRelation.*", "ContactAccountRelation.Create", "ContactAccountRelation.Delete", "ContactAccountRelation.Update", "Currency.*", "Currency.Create", "Currency.Delete", "Currency.Update", "CurrencyExchangeRate.*", "CurrencyExchangeRate.Create", "CurrencyExchangeRate.Delete", "CurrencyExchangeRate.Update", "CurrencyExchangeRatesList.*", "CurrencyExchangeRatesList.Create", "CurrencyExchangeRatesList.Delete", "CurrencyExchangeRatesList.Update", "CustomEntity.*", "CustomEntity.Create", "CustomEntity.Delete", "CustomEntity.DocumentLinked", "CustomEntity.OwnerChanged", "CustomEntity.Update", "Email.*", "Email.Create", "Email.Delete", "Email.DocumentLinked", "Email.Update", "Lead.*", "Lead.BackToLead", "Lead.Create", "Lead.Delete", "Lead.DocumentLinked", "Lead.Lost", "Lead.OwnerChanged", "Lead.Update", "LeadOpptyAccountRelation.*", "LeadOpptyAccountRelation.Create", "LeadOpptyAccountRelation.Delete", "LeadOpptyAccountRelation.Update", "LeadOpptyContactRelation.*", "LeadOpptyContactRelation.Create", "LeadOpptyContactRelation.Delete", "LeadOpptyContactRelation.Update", "Memo.*", "Memo.Comment", "Memo.Create", "Memo.Delete", "Memo.DocumentLinked", "Memo.Update", "Message.*", "Message.Create", "Message.Delete", "Message.DocumentLinked", "Message.Update", "Note.*", "Note.Create", "Note.Delete", "Note.Update", "Opportunity.*", "Opportunity.Create", "Opportunity.Delete", "Opportunity.DocumentLinked", "Opportunity.Lost", "Opportunity.Move", "Opportunity.OwnerChanged", "Opportunity.Qualify", "Opportunity.Update", "Opportunity.Won", "OpptyProductRelation.*", "OpptyProductRelation.Create", "OpptyProductRelation.Delete", "OpptyProductRelation.Update", "Product.*", "Product.Create", "Product.Delete", "Product.Update", "ProductPriceList.*", "ProductPriceList.Create", "ProductPriceList.Delete", "ProductPriceList.Update", "ProductPriceListPrice.*", "ProductPriceListPrice.Create", "ProductPriceListPrice.Delete", "ProductPriceListPrice.Update", "Project.*", "Project.Create", "Project.Delete", "Project.DocumentLinked", "Project.OwnerChanged", "Project.Update", "Quote.*", "Quote.Create", "Quote.Delete", "Quote.DocumentLinked", "Quote.Lost", "Quote.Move", "Quote.OwnerChanged", "Quote.Update", "Quote.Won", "QuoteAccountRelation.*", "QuoteAccountRelation.Create", "QuoteAccountRelation.Delete", "QuoteAccountRelation.Update", "QuoteContactRelation.*", "QuoteContactRelation.Create", "QuoteContactRelation.Delete", "QuoteContactRelation.Update", "Task.*", "Task.Comment", "Task.Create", "Task.Delete", "Task.DocumentLinked", "Task.OwnerChanged", "Task.Update"], "description": "Event type the parent webhook subscribes to (e.g. Account.Create, Lead.Update). The webhook fires whenever an event of this type occurs in the team space."}, "webhook_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent webhook."}}, "required": ["event", "webhook_id"]}, "updateWebhookEventInput": {"properties": {"event": {"type": "string", "example": "*", "enum": ["*", "Account.*", "Account.Create", "Account.Delete", "Account.DocumentLinked", "Account.OwnerChanged", "Account.Update", "ActivityRelation.*", "ActivityRelation.Create", "ActivityRelation.Delete", "ActivityRelation.Update", "Appointment.*", "Appointment.Comment", "Appointment.Create", "Appointment.Delete", "Appointment.DocumentLinked", "Appointment.OwnerChanged", "Appointment.Update", "Contact.*", "Contact.Create", "Contact.Delete", "Contact.DocumentLinked", "Contact.OwnerChanged", "Contact.Update", "ContactAccountRelation.*", "ContactAccountRelation.Create", "ContactAccountRelation.Delete", "ContactAccountRelation.Update", "Currency.*", "Currency.Create", "Currency.Delete", "Currency.Update", "CurrencyExchangeRate.*", "CurrencyExchangeRate.Create", "CurrencyExchangeRate.Delete", "CurrencyExchangeRate.Update", "CurrencyExchangeRatesList.*", "CurrencyExchangeRatesList.Create", "CurrencyExchangeRatesList.Delete", "CurrencyExchangeRatesList.Update", "CustomEntity.*", "CustomEntity.Create", "CustomEntity.Delete", "CustomEntity.DocumentLinked", "CustomEntity.OwnerChanged", "CustomEntity.Update", "Email.*", "Email.Create", "Email.Delete", "Email.DocumentLinked", "Email.Update", "Lead.*", "Lead.BackToLead", "Lead.Create", "Lead.Delete", "Lead.DocumentLinked", "Lead.Lost", "Lead.OwnerChanged", "Lead.Update", "LeadOpptyAccountRelation.*", "LeadOpptyAccountRelation.Create", "LeadOpptyAccountRelation.Delete", "LeadOpptyAccountRelation.Update", "LeadOpptyContactRelation.*", "LeadOpptyContactRelation.Create", "LeadOpptyContactRelation.Delete", "LeadOpptyContactRelation.Update", "Memo.*", "Memo.Comment", "Memo.Create", "Memo.Delete", "Memo.DocumentLinked", "Memo.Update", "Message.*", "Message.Create", "Message.Delete", "Message.DocumentLinked", "Message.Update", "Note.*", "Note.Create", "Note.Delete", "Note.Update", "Opportunity.*", "Opportunity.Create", "Opportunity.Delete", "Opportunity.DocumentLinked", "Opportunity.Lost", "Opportunity.Move", "Opportunity.OwnerChanged", "Opportunity.Qualify", "Opportunity.Update", "Opportunity.Won", "OpptyProductRelation.*", "OpptyProductRelation.Create", "OpptyProductRelation.Delete", "OpptyProductRelation.Update", "Product.*", "Product.Create", "Product.Delete", "Product.Update", "ProductPriceList.*", "ProductPriceList.Create", "ProductPriceList.Delete", "ProductPriceList.Update", "ProductPriceListPrice.*", "ProductPriceListPrice.Create", "ProductPriceListPrice.Delete", "ProductPriceListPrice.Update", "Project.*", "Project.Create", "Project.Delete", "Project.DocumentLinked", "Project.OwnerChanged", "Project.Update", "Quote.*", "Quote.Create", "Quote.Delete", "Quote.DocumentLinked", "Quote.Lost", "Quote.Move", "Quote.OwnerChanged", "Quote.Update", "Quote.Won", "QuoteAccountRelation.*", "QuoteAccountRelation.Create", "QuoteAccountRelation.Delete", "QuoteAccountRelation.Update", "QuoteContactRelation.*", "QuoteContactRelation.Create", "QuoteContactRelation.Delete", "QuoteContactRelation.Update", "Task.*", "Task.Comment", "Task.Create", "Task.Delete", "Task.DocumentLinked", "Task.OwnerChanged", "Task.Update"], "description": "Event type the parent webhook subscribes to (e.g. Account.Create, Lead.Update). The webhook fires whenever an event of this type occurs in the team space."}, "webhook_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent webhook."}}}, "batchWebhookEventInput": {"properties": {"event": {"type": "string", "example": "*", "enum": ["*", "Account.*", "Account.Create", "Account.Delete", "Account.DocumentLinked", "Account.OwnerChanged", "Account.Update", "ActivityRelation.*", "ActivityRelation.Create", "ActivityRelation.Delete", "ActivityRelation.Update", "Appointment.*", "Appointment.Comment", "Appointment.Create", "Appointment.Delete", "Appointment.DocumentLinked", "Appointment.OwnerChanged", "Appointment.Update", "Contact.*", "Contact.Create", "Contact.Delete", "Contact.DocumentLinked", "Contact.OwnerChanged", "Contact.Update", "ContactAccountRelation.*", "ContactAccountRelation.Create", "ContactAccountRelation.Delete", "ContactAccountRelation.Update", "Currency.*", "Currency.Create", "Currency.Delete", "Currency.Update", "CurrencyExchangeRate.*", "CurrencyExchangeRate.Create", "CurrencyExchangeRate.Delete", "CurrencyExchangeRate.Update", "CurrencyExchangeRatesList.*", "CurrencyExchangeRatesList.Create", "CurrencyExchangeRatesList.Delete", "CurrencyExchangeRatesList.Update", "CustomEntity.*", "CustomEntity.Create", "CustomEntity.Delete", "CustomEntity.DocumentLinked", "CustomEntity.OwnerChanged", "CustomEntity.Update", "Email.*", "Email.Create", "Email.Delete", "Email.DocumentLinked", "Email.Update", "Lead.*", "Lead.BackToLead", "Lead.Create", "Lead.Delete", "Lead.DocumentLinked", "Lead.Lost", "Lead.OwnerChanged", "Lead.Update", "LeadOpptyAccountRelation.*", "LeadOpptyAccountRelation.Create", "LeadOpptyAccountRelation.Delete", "LeadOpptyAccountRelation.Update", "LeadOpptyContactRelation.*", "LeadOpptyContactRelation.Create", "LeadOpptyContactRelation.Delete", "LeadOpptyContactRelation.Update", "Memo.*", "Memo.Comment", "Memo.Create", "Memo.Delete", "Memo.DocumentLinked", "Memo.Update", "Message.*", "Message.Create", "Message.Delete", "Message.DocumentLinked", "Message.Update", "Note.*", "Note.Create", "Note.Delete", "Note.Update", "Opportunity.*", "Opportunity.Create", "Opportunity.Delete", "Opportunity.DocumentLinked", "Opportunity.Lost", "Opportunity.Move", "Opportunity.OwnerChanged", "Opportunity.Qualify", "Opportunity.Update", "Opportunity.Won", "OpptyProductRelation.*", "OpptyProductRelation.Create", "OpptyProductRelation.Delete", "OpptyProductRelation.Update", "Product.*", "Product.Create", "Product.Delete", "Product.Update", "ProductPriceList.*", "ProductPriceList.Create", "ProductPriceList.Delete", "ProductPriceList.Update", "ProductPriceListPrice.*", "ProductPriceListPrice.Create", "ProductPriceListPrice.Delete", "ProductPriceListPrice.Update", "Project.*", "Project.Create", "Project.Delete", "Project.DocumentLinked", "Project.OwnerChanged", "Project.Update", "Quote.*", "Quote.Create", "Quote.Delete", "Quote.DocumentLinked", "Quote.Lost", "Quote.Move", "Quote.OwnerChanged", "Quote.Update", "Quote.Won", "QuoteAccountRelation.*", "QuoteAccountRelation.Create", "QuoteAccountRelation.Delete", "QuoteAccountRelation.Update", "QuoteContactRelation.*", "QuoteContactRelation.Create", "QuoteContactRelation.Delete", "QuoteContactRelation.Update", "Task.*", "Task.Comment", "Task.Create", "Task.Delete", "Task.DocumentLinked", "Task.OwnerChanged", "Task.Update"], "description": "Event type the parent webhook subscribes to (e.g. Account.Create, Lead.Update). The webhook fires whenever an event of this type occurs in the team space."}, "webhook_id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Id of the parent webhook."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}, "Webresource": {"properties": {"is_delete_protected": {"type": "boolean", "example": false, "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true}, "has_draft": {"type": "boolean", "example": false, "description": "Set to True if draft for entity exists and can be published"}, "id": {"type": "string", "format": "uuid", "example": "01234567-abcd-dcba-ffff-000000000000", "description": "Unique identifier of entity.", "readOnly": true}, "is_deleted": {"type": "boolean", "example": false, "description": "Specifies if the entity is considered deleted.", "readOnly": true}, "modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "display_param": {"type": "string", "example": 1, "enum": [1, 2], "description": "Bit flag controlling how the web resource is displayed (e.g. full-screen, in a tab)."}, "entity": {"type": "string", "example": "string", "description": "Name of the entity the web resource is attached to (e.g. \"Account\", \"Lead\")."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "request_method": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Get, 2 - Post", "example": 1, "enum": [1, 2]}, "url": {"type": "string", "example": "string", "description": "URL template for the embedded web resource. May reference field values via \"{#<field_id>}\" placeholders that are substituted with the current record's values."}, "is_published": {"type": "boolean", "example": false, "description": "True when the web resource is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["is_delete_protected", "has_draft", "id", "display_param", "entity", "name"]}, "createWebresourceInput": {"properties": {"modified": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Last modification time.", "readOnly": true}, "created": {"type": "string", "format": "date-time", "example": "2019-01-01T00:00:00", "description": "Creation time.", "readOnly": true}, "display_param": {"type": "string", "example": 1, "enum": [1, 2], "description": "Bit flag controlling how the web resource is displayed (e.g. full-screen, in a tab)."}, "entity": {"type": "string", "example": "string", "description": "Name of the entity the web resource is attached to (e.g. \"Account\", \"Lead\")."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "request_method": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Get, 2 - Post", "example": 1, "enum": [1, 2]}, "url": {"type": "string", "example": "string", "description": "URL template for the embedded web resource. May reference field values via \"{#<field_id>}\" placeholders that are substituted with the current record's values."}, "is_published": {"type": "boolean", "example": false, "description": "True when the web resource is published; false while it exists only as an unpublished draft.", "readOnly": true}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}, "required": ["display_param", "entity", "name"]}, "updateWebresourceInput": {"properties": {"display_param": {"type": "string", "example": 1, "enum": [1, 2], "description": "Bit flag controlling how the web resource is displayed (e.g. full-screen, in a tab)."}, "entity": {"type": "string", "example": "string", "description": "Name of the entity the web resource is attached to (e.g. \"Account\", \"Lead\")."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "request_method": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Get, 2 - Post", "example": 1, "enum": [1, 2]}, "url": {"type": "string", "example": "string", "description": "URL template for the embedded web resource. May reference field values via \"{#<field_id>}\" placeholders that are substituted with the current record's values."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}}}, "batchWebresourceInput": {"properties": {"display_param": {"type": "string", "example": 1, "enum": [1, 2], "description": "Bit flag controlling how the web resource is displayed (e.g. full-screen, in a tab)."}, "entity": {"type": "string", "example": "string", "description": "Name of the entity the web resource is attached to (e.g. \"Account\", \"Lead\")."}, "name": {"type": "string", "example": "string", "description": "Name of the entity and its default text representation."}, "request_method": {"type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Get, 2 - Post", "example": 1, "enum": [1, 2]}, "url": {"type": "string", "example": "string", "description": "URL template for the embedded web resource. May reference field values via \"{#<field_id>}\" placeholders that are substituted with the current record's values."}, "revision": {"type": "integer", "format": "int32", "example": 1, "description": "Revision when entity was lastly changed."}, "id": {"description": "ID of object to update.", "type": "string", "format": "uuid"}}}}}}