openapi: 3.2.0 info: title: Pipeliner Cloud Activity API version: '100' 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} tags: - name: Activity paths: /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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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/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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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/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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - 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' components: schemas: 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. Integer 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 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. Integer 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 updateActivityRelationInput: properties: project_objective: type: object properties: id: type: string format: uri description: 'Project objective the activity advances, or empty. Relation 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. 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. 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: type: string format: uri description: 'Task this enrichment record applies to. Set when activity_id resolves to a Task; otherwise empty. 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.' data: type: string format: uri description: 'External data record (Data entity) holding the enrichment payload. Relation 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 batchTaskSharingSalesUnitRelationInput: properties: role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the task. Integer 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 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). Integer 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). Integer 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). Integer 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). Integer 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). Integer 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 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 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. Relation 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. Relation 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. 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.' 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. 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.' schedule: type: string format: uri description: 'Appointment schedule (booking link) this appointment was created through, or empty for appointments created directly. Relation 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. 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.' 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 — 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. Integer 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. Relation 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 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. Integer 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. 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). Integer 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). Integer 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. Integer 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. Relation 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: '' 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. Integer 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. 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. Integer 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 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 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 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. Integer 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 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. Integer 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. 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. Integer 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. Integer 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). Integer 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. Integer 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. 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. Relation 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 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. 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. Integer 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. 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). Integer 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). Integer 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 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. Integer 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 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). Integer 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). Integer 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. Integer 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. Relation 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. Relation 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 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. Integer 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 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. Relation 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 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. Integer 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 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. 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.' appointment_type: type: string format: uri description: 'Appointment type used when a booking is created. Relation 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). 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.' 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. Relation 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). Integer 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). Integer 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). Integer 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). Integer 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). Integer 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 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). Integer 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). Integer 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). Integer 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). Integer 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). Integer 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). 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 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). Integer 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 updateTaskSharingSalesUnitRelationInput: properties: role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the task. Integer 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. 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. 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.' unit: type: string format: uri description: 'Sales unit the task is shared with. 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.' role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the task. Integer 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 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). Integer 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 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). Integer 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). Integer 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. 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. 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.' owner: type: string format: uri description: 'User who set this reminder. Reminders are per-user. 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.' 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). Integer 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 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. Integer 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 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. 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.' contact: type: string format: uri description: 'Coevera Contact record matching the invitee email, when one exists. 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.' 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). Integer 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). Integer 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 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. 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. Integer 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. Integer 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). Integer 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. Integer 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 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). Integer 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. 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 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. Integer 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. Integer 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). Integer 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. Integer 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 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. 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.' 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. Integer 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. Integer 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). Integer 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. Integer 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 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). Integer 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. 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. 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: type: string format: uri description: 'Task this comment belongs to. Set when activity_id resolves to a Task; otherwise empty. 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.' owner: type: string format: uri description: 'User who authored the comment. 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.' 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 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. 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.' client: type: string format: uri description: 'Internal user invited to the appointment. 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.' 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). Integer 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 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. 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: type: string format: uri description: 'Appointment side of the link. Set when activity_id resolves to an Appointment; otherwise empty. 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: type: string format: uri description: 'Task side of the link. Set when activity_id resolves to a Task; otherwise empty. 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.' contact: type: string format: uri description: 'Contact the activity is linked to, or empty when not linked to a contact. 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: type: string format: uri description: 'Custom entity record the activity is linked to, or empty. 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.' lead: type: string format: uri description: 'Lead the activity is linked to. Set when lead_oppty_id resolves to a Lead; otherwise empty. 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: type: string format: uri description: 'Opportunity the activity is linked to. Set when lead_oppty_id resolves to an Opportunity; otherwise empty. 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.' project: type: string format: uri description: 'Project the activity is linked to, or empty when not linked to a project. 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_objective: type: string format: uri description: 'Project objective the activity advances, or empty. 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.' quote: type: string format: uri description: 'Quote the activity is linked to, or empty when not linked to a quote. 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_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 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. 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.' task: type: string format: uri description: 'Task being shared. 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_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. Integer 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 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). Integer 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). Integer 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. Integer 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. Relation 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 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. Integer 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. Integer 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 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. 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.' task: type: string format: uri description: 'Task this reminder belongs to. 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.' 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). Integer 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 batchActivityRelationInput: properties: project_objective: type: object properties: id: type: string format: uri description: 'Project objective the activity advances, or empty. Relation 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 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. Relation 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. Relation 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). Relation 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. Relation 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. 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.' 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. 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.' 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). Integer 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). Integer 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. Integer 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 — 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. Relation 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. Relation 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 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. 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: type: string format: uri description: 'Task this KPI event relates to. Set when activity_id resolves to a Task; otherwise empty. 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: type: string format: uri description: 'User who triggered the KPI event (e.g. created or completed the activity). 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.' owner: type: string format: uri description: 'Activity owner at the time the KPI event occurred. 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.' unit: type: string format: uri description: 'Sales unit the triggering user belonged to at the time of the event. 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.' 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. Integer 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 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). Integer 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). Integer 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 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. Integer 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 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). Integer 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. 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). Integer 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 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). Integer 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 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). Integer 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 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). Integer 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 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). Integer 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). Integer 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). Integer 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). Integer 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). Integer 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