openapi: 3.2.0 info: title: Pipeliner Cloud Email 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: Email paths: /entities/Emails/{id}: get: description: Returns Email with given id operationId: Emails.get summary: Emails.get tags: - Email parameters: - name: id in: path description: ID of Email to retrieve required: true schema: type: string format: uuid responses: '200': description: Email data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/Email' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes Email with given id operationId: Emails.delete summary: Emails.delete tags: - Email parameters: - name: id in: path description: ID of Email to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of Email on delete. Use them as bit mask: 0 - validate each field on entity, 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 Email type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies Email or Emails with given id(s) parameters: - name: id in: path description: ID of Email to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of Email on update. Use them as bit mask: 0 - validate each field on entity, 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: Emails.update summary: Emails.update tags: - Email requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateEmailInput' responses: '200': description: Modification confirmation. Returns resulting Email content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/Email' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Emails: get: description: Returns all defined Emails operationId: Emails.list summary: Emails.list tags: - Email parameters: - name: include-deleted in: query description: if enabled, deleted Emails are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Emails content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/Email' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new Email operationId: Emails.create summary: Emails.create tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of Email on create. Use them as bit mask: 0 - validate each field on entity, 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 Email required: true content: application / json: schema: $ref: '#/components/schemas/createEmailInput' responses: '201': description: Creation confirmation. Returns created Email content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/Email' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Emails/batch-delete: post: description: Removes Emails with given list of ids operationId: Emails.batch_delete summary: Emails.batch_delete tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of Emails on delete. Use them as bit mask: 0 - validate each field on entity, 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 Emails. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity Email to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted Email. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Emails/batch-modify: post: description: Create or update an batch of Emails operationId: Emails.batch_create_or_update summary: Emails.batch_create_or_update tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of Emails on change. Use them as bit mask: 0 - validate each field on entity, 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 Emails. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new Email required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchEmailInput' responses: '200': description: Creation confirmation. Returns a list of created / updated Emails content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Emails/batch-restore: post: description: Restores Emails with given list of ids operationId: Emails.batch_restore summary: Emails.batch_restore tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of Emails on restore. Use them as bit mask: 0 - validate each field on entity, 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 Emails. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity Email to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored Email. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailContentSharingClientRelations/{id}: get: description: Returns EmailContentSharingClientRelation with given id operationId: EmailContentSharingClientRelations.get summary: EmailContentSharingClientRelations.get tags: - Email parameters: - name: id in: path description: ID of EmailContentSharingClientRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: EmailContentSharingClientRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailContentSharingClientRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes EmailContentSharingClientRelation with given id operationId: EmailContentSharingClientRelations.delete summary: EmailContentSharingClientRelations.delete tags: - Email parameters: - name: id in: path description: ID of EmailContentSharingClientRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of EmailContentSharingClientRelation on delete. Use them as bit mask: 0 - validate each field on entity, 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 EmailContentSharingClientRelation type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies EmailContentSharingClientRelation or EmailContentSharingClientRelations with given id(s) parameters: - name: id in: path description: ID of EmailContentSharingClientRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of EmailContentSharingClientRelation on update. Use them as bit mask: 0 - validate each field on entity, 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: EmailContentSharingClientRelations.update summary: EmailContentSharingClientRelations.update tags: - Email requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateEmailContentSharingClientRelationInput' responses: '200': description: Modification confirmation. Returns resulting EmailContentSharingClientRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailContentSharingClientRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailContentSharingClientRelations: get: description: Returns all defined EmailContentSharingClientRelations operationId: EmailContentSharingClientRelations.list summary: EmailContentSharingClientRelations.list tags: - Email parameters: - name: include-deleted in: query description: if enabled, deleted EmailContentSharingClientRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of EmailContentSharingClientRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/EmailContentSharingClientRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new EmailContentSharingClientRelation operationId: EmailContentSharingClientRelations.create summary: EmailContentSharingClientRelations.create tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailContentSharingClientRelation on create. Use them as bit mask: 0 - validate each field on entity, 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 EmailContentSharingClientRelation required: true content: application / json: schema: $ref: '#/components/schemas/createEmailContentSharingClientRelationInput' responses: '201': description: Creation confirmation. Returns created EmailContentSharingClientRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailContentSharingClientRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailContentSharingClientRelations/batch-delete: post: description: Removes EmailContentSharingClientRelations with given list of ids operationId: EmailContentSharingClientRelations.batch_delete summary: EmailContentSharingClientRelations.batch_delete tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailContentSharingClientRelations on delete. Use them as bit mask: 0 - validate each field on entity, 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 EmailContentSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity EmailContentSharingClientRelation to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted EmailContentSharingClientRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailContentSharingClientRelations/batch-modify: post: description: Create or update an batch of EmailContentSharingClientRelations operationId: EmailContentSharingClientRelations.batch_create_or_update summary: EmailContentSharingClientRelations.batch_create_or_update tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailContentSharingClientRelations on change. Use them as bit mask: 0 - validate each field on entity, 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 EmailContentSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new EmailContentSharingClientRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchEmailContentSharingClientRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated EmailContentSharingClientRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailContentSharingClientRelations/batch-restore: post: description: Restores EmailContentSharingClientRelations with given list of ids operationId: EmailContentSharingClientRelations.batch_restore summary: EmailContentSharingClientRelations.batch_restore tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailContentSharingClientRelations on restore. Use them as bit mask: 0 - validate each field on entity, 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 EmailContentSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity EmailContentSharingClientRelation to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored EmailContentSharingClientRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailContentSharingSalesUnitRelations/{id}: get: description: Returns EmailContentSharingSalesUnitRelation with given id operationId: EmailContentSharingSalesUnitRelations.get summary: EmailContentSharingSalesUnitRelations.get tags: - Email parameters: - name: id in: path description: ID of EmailContentSharingSalesUnitRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: EmailContentSharingSalesUnitRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailContentSharingSalesUnitRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes EmailContentSharingSalesUnitRelation with given id operationId: EmailContentSharingSalesUnitRelations.delete summary: EmailContentSharingSalesUnitRelations.delete tags: - Email parameters: - name: id in: path description: ID of EmailContentSharingSalesUnitRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of EmailContentSharingSalesUnitRelation on delete. Use them as bit mask: 0 - validate each field on entity, 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 EmailContentSharingSalesUnitRelation type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies EmailContentSharingSalesUnitRelation or EmailContentSharingSalesUnitRelations with given id(s) parameters: - name: id in: path description: ID of EmailContentSharingSalesUnitRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of EmailContentSharingSalesUnitRelation on update. Use them as bit mask: 0 - validate each field on entity, 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: EmailContentSharingSalesUnitRelations.update summary: EmailContentSharingSalesUnitRelations.update tags: - Email requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateEmailContentSharingSalesUnitRelationInput' responses: '200': description: Modification confirmation. Returns resulting EmailContentSharingSalesUnitRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailContentSharingSalesUnitRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailContentSharingSalesUnitRelations: get: description: Returns all defined EmailContentSharingSalesUnitRelations operationId: EmailContentSharingSalesUnitRelations.list summary: EmailContentSharingSalesUnitRelations.list tags: - Email parameters: - name: include-deleted in: query description: if enabled, deleted EmailContentSharingSalesUnitRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of EmailContentSharingSalesUnitRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/EmailContentSharingSalesUnitRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new EmailContentSharingSalesUnitRelation operationId: EmailContentSharingSalesUnitRelations.create summary: EmailContentSharingSalesUnitRelations.create tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailContentSharingSalesUnitRelation on create. Use them as bit mask: 0 - validate each field on entity, 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 EmailContentSharingSalesUnitRelation required: true content: application / json: schema: $ref: '#/components/schemas/createEmailContentSharingSalesUnitRelationInput' responses: '201': description: Creation confirmation. Returns created EmailContentSharingSalesUnitRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailContentSharingSalesUnitRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailContentSharingSalesUnitRelations/batch-delete: post: description: Removes EmailContentSharingSalesUnitRelations with given list of ids operationId: EmailContentSharingSalesUnitRelations.batch_delete summary: EmailContentSharingSalesUnitRelations.batch_delete tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailContentSharingSalesUnitRelations on delete. Use them as bit mask: 0 - validate each field on entity, 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 EmailContentSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity EmailContentSharingSalesUnitRelation to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted EmailContentSharingSalesUnitRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailContentSharingSalesUnitRelations/batch-modify: post: description: Create or update an batch of EmailContentSharingSalesUnitRelations operationId: EmailContentSharingSalesUnitRelations.batch_create_or_update summary: EmailContentSharingSalesUnitRelations.batch_create_or_update tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailContentSharingSalesUnitRelations on change. Use them as bit mask: 0 - validate each field on entity, 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 EmailContentSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new EmailContentSharingSalesUnitRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchEmailContentSharingSalesUnitRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated EmailContentSharingSalesUnitRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailContentSharingSalesUnitRelations/batch-restore: post: description: Restores EmailContentSharingSalesUnitRelations with given list of ids operationId: EmailContentSharingSalesUnitRelations.batch_restore summary: EmailContentSharingSalesUnitRelations.batch_restore tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailContentSharingSalesUnitRelations on restore. Use them as bit mask: 0 - validate each field on entity, 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 EmailContentSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity EmailContentSharingSalesUnitRelation to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored EmailContentSharingSalesUnitRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailEvents/{id}: get: description: Returns EmailEvent with given id operationId: EmailEvents.get summary: EmailEvents.get tags: - Email parameters: - name: id in: path description: ID of EmailEvent to retrieve required: true schema: type: string format: uuid responses: '200': description: EmailEvent data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailEvent' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes EmailEvent with given id operationId: EmailEvents.delete summary: EmailEvents.delete tags: - Email parameters: - name: id in: path description: ID of EmailEvent to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of EmailEvent on delete. Use them as bit mask: 0 - validate each field on entity, 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 EmailEvent type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies EmailEvent or EmailEvents with given id(s) parameters: - name: id in: path description: ID of EmailEvent to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of EmailEvent on update. Use them as bit mask: 0 - validate each field on entity, 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: EmailEvents.update summary: EmailEvents.update tags: - Email requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateEmailEventInput' responses: '200': description: Modification confirmation. Returns resulting EmailEvent content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailEvent' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailEvents: get: description: Returns all defined EmailEvents operationId: EmailEvents.list summary: EmailEvents.list tags: - Email parameters: - name: include-deleted in: query description: if enabled, deleted EmailEvents are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of EmailEvents content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/EmailEvent' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new EmailEvent operationId: EmailEvents.create summary: EmailEvents.create tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailEvent on create. Use them as bit mask: 0 - validate each field on entity, 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 EmailEvent required: true content: application / json: schema: $ref: '#/components/schemas/createEmailEventInput' responses: '201': description: Creation confirmation. Returns created EmailEvent content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailEvent' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailEvents/batch-delete: post: description: Removes EmailEvents with given list of ids operationId: EmailEvents.batch_delete summary: EmailEvents.batch_delete tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailEvents on delete. Use them as bit mask: 0 - validate each field on entity, 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 EmailEvents. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity EmailEvent to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted EmailEvent. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailEvents/batch-modify: post: description: Create or update an batch of EmailEvents operationId: EmailEvents.batch_create_or_update summary: EmailEvents.batch_create_or_update tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailEvents on change. Use them as bit mask: 0 - validate each field on entity, 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 EmailEvents. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new EmailEvent required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchEmailEventInput' responses: '200': description: Creation confirmation. Returns a list of created / updated EmailEvents content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailEvents/batch-restore: post: description: Restores EmailEvents with given list of ids operationId: EmailEvents.batch_restore summary: EmailEvents.batch_restore tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailEvents on restore. Use them as bit mask: 0 - validate each field on entity, 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 EmailEvents. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity EmailEvent to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored EmailEvent. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailMailboxRelations/{id}: get: description: Returns EmailMailboxRelation with given id operationId: EmailMailboxRelations.get summary: EmailMailboxRelations.get tags: - Email parameters: - name: id in: path description: ID of EmailMailboxRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: EmailMailboxRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailMailboxRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes EmailMailboxRelation with given id operationId: EmailMailboxRelations.delete summary: EmailMailboxRelations.delete tags: - Email parameters: - name: id in: path description: ID of EmailMailboxRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of EmailMailboxRelation on delete. Use them as bit mask: 0 - validate each field on entity, 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 EmailMailboxRelation type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies EmailMailboxRelation or EmailMailboxRelations with given id(s) parameters: - name: id in: path description: ID of EmailMailboxRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of EmailMailboxRelation on update. Use them as bit mask: 0 - validate each field on entity, 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: EmailMailboxRelations.update summary: EmailMailboxRelations.update tags: - Email requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateEmailMailboxRelationInput' responses: '200': description: Modification confirmation. Returns resulting EmailMailboxRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailMailboxRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailMailboxRelations: get: description: Returns all defined EmailMailboxRelations operationId: EmailMailboxRelations.list summary: EmailMailboxRelations.list tags: - Email parameters: - name: include-deleted in: query description: if enabled, deleted EmailMailboxRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of EmailMailboxRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/EmailMailboxRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new EmailMailboxRelation operationId: EmailMailboxRelations.create summary: EmailMailboxRelations.create tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailMailboxRelation on create. Use them as bit mask: 0 - validate each field on entity, 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 EmailMailboxRelation required: true content: application / json: schema: $ref: '#/components/schemas/createEmailMailboxRelationInput' responses: '201': description: Creation confirmation. Returns created EmailMailboxRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailMailboxRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailMailboxRelations/batch-delete: post: description: Removes EmailMailboxRelations with given list of ids operationId: EmailMailboxRelations.batch_delete summary: EmailMailboxRelations.batch_delete tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailMailboxRelations on delete. Use them as bit mask: 0 - validate each field on entity, 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 EmailMailboxRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity EmailMailboxRelation to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted EmailMailboxRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailMailboxRelations/batch-modify: post: description: Create or update an batch of EmailMailboxRelations operationId: EmailMailboxRelations.batch_create_or_update summary: EmailMailboxRelations.batch_create_or_update tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailMailboxRelations on change. Use them as bit mask: 0 - validate each field on entity, 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 EmailMailboxRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new EmailMailboxRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchEmailMailboxRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated EmailMailboxRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailMailboxRelations/batch-restore: post: description: Restores EmailMailboxRelations with given list of ids operationId: EmailMailboxRelations.batch_restore summary: EmailMailboxRelations.batch_restore tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailMailboxRelations on restore. Use them as bit mask: 0 - validate each field on entity, 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 EmailMailboxRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity EmailMailboxRelation to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored EmailMailboxRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailTemplates/{id}: get: description: Returns EmailTemplate with given id operationId: EmailTemplates.get summary: EmailTemplates.get tags: - Email parameters: - name: id in: path description: ID of EmailTemplate to retrieve required: true schema: type: string format: uuid responses: '200': description: EmailTemplate data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailTemplate' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes EmailTemplate with given id operationId: EmailTemplates.delete summary: EmailTemplates.delete tags: - Email parameters: - name: id in: path description: ID of EmailTemplate to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of EmailTemplate on delete. Use them as bit mask: 0 - validate each field on entity, 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 EmailTemplate type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies EmailTemplate or EmailTemplates with given id(s) parameters: - name: id in: path description: ID of EmailTemplate to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of EmailTemplate on update. Use them as bit mask: 0 - validate each field on entity, 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: EmailTemplates.update summary: EmailTemplates.update tags: - Email requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateEmailTemplateInput' responses: '200': description: Modification confirmation. Returns resulting EmailTemplate content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailTemplate' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailTemplates: get: description: Returns all defined EmailTemplates operationId: EmailTemplates.list summary: EmailTemplates.list tags: - Email parameters: - name: include-deleted in: query description: if enabled, deleted EmailTemplates are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of EmailTemplates content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/EmailTemplate' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new EmailTemplate operationId: EmailTemplates.create summary: EmailTemplates.create tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailTemplate on create. Use them as bit mask: 0 - validate each field on entity, 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 EmailTemplate required: true content: application / json: schema: $ref: '#/components/schemas/createEmailTemplateInput' responses: '201': description: Creation confirmation. Returns created EmailTemplate content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailTemplate' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailTemplates/batch-delete: post: description: Removes EmailTemplates with given list of ids operationId: EmailTemplates.batch_delete summary: EmailTemplates.batch_delete tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailTemplates on delete. Use them as bit mask: 0 - validate each field on entity, 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 EmailTemplates. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity EmailTemplate to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted EmailTemplate. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailTemplates/batch-modify: post: description: Create or update an batch of EmailTemplates operationId: EmailTemplates.batch_create_or_update summary: EmailTemplates.batch_create_or_update tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailTemplates on change. Use them as bit mask: 0 - validate each field on entity, 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 EmailTemplates. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new EmailTemplate required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchEmailTemplateInput' responses: '200': description: Creation confirmation. Returns a list of created / updated EmailTemplates content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailTemplates/batch-restore: post: description: Restores EmailTemplates with given list of ids operationId: EmailTemplates.batch_restore summary: EmailTemplates.batch_restore tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailTemplates on restore. Use them as bit mask: 0 - validate each field on entity, 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 EmailTemplates. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity EmailTemplate to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored EmailTemplate. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailTemplateFolders/{id}: get: description: Returns EmailTemplateFolder with given id operationId: EmailTemplateFolders.get summary: EmailTemplateFolders.get tags: - Email parameters: - name: id in: path description: ID of EmailTemplateFolder to retrieve required: true schema: type: string format: uuid responses: '200': description: EmailTemplateFolder data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailTemplateFolder' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes EmailTemplateFolder with given id operationId: EmailTemplateFolders.delete summary: EmailTemplateFolders.delete tags: - Email parameters: - name: id in: path description: ID of EmailTemplateFolder to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of EmailTemplateFolder on delete. Use them as bit mask: 0 - validate each field on entity, 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 EmailTemplateFolder type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies EmailTemplateFolder or EmailTemplateFolders with given id(s) parameters: - name: id in: path description: ID of EmailTemplateFolder to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of EmailTemplateFolder on update. Use them as bit mask: 0 - validate each field on entity, 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: EmailTemplateFolders.update summary: EmailTemplateFolders.update tags: - Email requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateEmailTemplateFolderInput' responses: '200': description: Modification confirmation. Returns resulting EmailTemplateFolder content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailTemplateFolder' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailTemplateFolders: get: description: Returns all defined EmailTemplateFolders operationId: EmailTemplateFolders.list summary: EmailTemplateFolders.list tags: - Email parameters: - name: include-deleted in: query description: if enabled, deleted EmailTemplateFolders are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of EmailTemplateFolders content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/EmailTemplateFolder' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new EmailTemplateFolder operationId: EmailTemplateFolders.create summary: EmailTemplateFolders.create tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailTemplateFolder on create. Use them as bit mask: 0 - validate each field on entity, 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 EmailTemplateFolder required: true content: application / json: schema: $ref: '#/components/schemas/createEmailTemplateFolderInput' responses: '201': description: Creation confirmation. Returns created EmailTemplateFolder content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailTemplateFolder' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailTemplateFolders/batch-delete: post: description: Removes EmailTemplateFolders with given list of ids operationId: EmailTemplateFolders.batch_delete summary: EmailTemplateFolders.batch_delete tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailTemplateFolders on delete. Use them as bit mask: 0 - validate each field on entity, 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 EmailTemplateFolders. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity EmailTemplateFolder to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted EmailTemplateFolder. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailTemplateFolders/batch-modify: post: description: Create or update an batch of EmailTemplateFolders operationId: EmailTemplateFolders.batch_create_or_update summary: EmailTemplateFolders.batch_create_or_update tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailTemplateFolders on change. Use them as bit mask: 0 - validate each field on entity, 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 EmailTemplateFolders. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new EmailTemplateFolder required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchEmailTemplateFolderInput' responses: '200': description: Creation confirmation. Returns a list of created / updated EmailTemplateFolders content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailTemplateFolders/batch-restore: post: description: Restores EmailTemplateFolders with given list of ids operationId: EmailTemplateFolders.batch_restore summary: EmailTemplateFolders.batch_restore tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailTemplateFolders on restore. Use them as bit mask: 0 - validate each field on entity, 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 EmailTemplateFolders. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity EmailTemplateFolder to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored EmailTemplateFolder. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailTemplateSharingClientRelations/{id}: get: description: Returns EmailTemplateSharingClientRelation with given id operationId: EmailTemplateSharingClientRelations.get summary: EmailTemplateSharingClientRelations.get tags: - Email parameters: - name: id in: path description: ID of EmailTemplateSharingClientRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: EmailTemplateSharingClientRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailTemplateSharingClientRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes EmailTemplateSharingClientRelation with given id operationId: EmailTemplateSharingClientRelations.delete summary: EmailTemplateSharingClientRelations.delete tags: - Email parameters: - name: id in: path description: ID of EmailTemplateSharingClientRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of EmailTemplateSharingClientRelation on delete. Use them as bit mask: 0 - validate each field on entity, 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 EmailTemplateSharingClientRelation type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies EmailTemplateSharingClientRelation or EmailTemplateSharingClientRelations with given id(s) parameters: - name: id in: path description: ID of EmailTemplateSharingClientRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of EmailTemplateSharingClientRelation on update. Use them as bit mask: 0 - validate each field on entity, 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: EmailTemplateSharingClientRelations.update summary: EmailTemplateSharingClientRelations.update tags: - Email requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateEmailTemplateSharingClientRelationInput' responses: '200': description: Modification confirmation. Returns resulting EmailTemplateSharingClientRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailTemplateSharingClientRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailTemplateSharingClientRelations: get: description: Returns all defined EmailTemplateSharingClientRelations operationId: EmailTemplateSharingClientRelations.list summary: EmailTemplateSharingClientRelations.list tags: - Email parameters: - name: include-deleted in: query description: if enabled, deleted EmailTemplateSharingClientRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of EmailTemplateSharingClientRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/EmailTemplateSharingClientRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new EmailTemplateSharingClientRelation operationId: EmailTemplateSharingClientRelations.create summary: EmailTemplateSharingClientRelations.create tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailTemplateSharingClientRelation on create. Use them as bit mask: 0 - validate each field on entity, 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 EmailTemplateSharingClientRelation required: true content: application / json: schema: $ref: '#/components/schemas/createEmailTemplateSharingClientRelationInput' responses: '201': description: Creation confirmation. Returns created EmailTemplateSharingClientRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailTemplateSharingClientRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailTemplateSharingClientRelations/batch-delete: post: description: Removes EmailTemplateSharingClientRelations with given list of ids operationId: EmailTemplateSharingClientRelations.batch_delete summary: EmailTemplateSharingClientRelations.batch_delete tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailTemplateSharingClientRelations on delete. Use them as bit mask: 0 - validate each field on entity, 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 EmailTemplateSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity EmailTemplateSharingClientRelation to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted EmailTemplateSharingClientRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailTemplateSharingClientRelations/batch-modify: post: description: Create or update an batch of EmailTemplateSharingClientRelations operationId: EmailTemplateSharingClientRelations.batch_create_or_update summary: EmailTemplateSharingClientRelations.batch_create_or_update tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailTemplateSharingClientRelations on change. Use them as bit mask: 0 - validate each field on entity, 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 EmailTemplateSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new EmailTemplateSharingClientRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchEmailTemplateSharingClientRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated EmailTemplateSharingClientRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailTemplateSharingClientRelations/batch-restore: post: description: Restores EmailTemplateSharingClientRelations with given list of ids operationId: EmailTemplateSharingClientRelations.batch_restore summary: EmailTemplateSharingClientRelations.batch_restore tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailTemplateSharingClientRelations on restore. Use them as bit mask: 0 - validate each field on entity, 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 EmailTemplateSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity EmailTemplateSharingClientRelation to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored EmailTemplateSharingClientRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailTemplateSharingSalesUnitRelations/{id}: get: description: Returns EmailTemplateSharingSalesUnitRelation with given id operationId: EmailTemplateSharingSalesUnitRelations.get summary: EmailTemplateSharingSalesUnitRelations.get tags: - Email parameters: - name: id in: path description: ID of EmailTemplateSharingSalesUnitRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: EmailTemplateSharingSalesUnitRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailTemplateSharingSalesUnitRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes EmailTemplateSharingSalesUnitRelation with given id operationId: EmailTemplateSharingSalesUnitRelations.delete summary: EmailTemplateSharingSalesUnitRelations.delete tags: - Email parameters: - name: id in: path description: ID of EmailTemplateSharingSalesUnitRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of EmailTemplateSharingSalesUnitRelation on delete. Use them as bit mask: 0 - validate each field on entity, 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 EmailTemplateSharingSalesUnitRelation type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies EmailTemplateSharingSalesUnitRelation or EmailTemplateSharingSalesUnitRelations with given id(s) parameters: - name: id in: path description: ID of EmailTemplateSharingSalesUnitRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of EmailTemplateSharingSalesUnitRelation on update. Use them as bit mask: 0 - validate each field on entity, 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: EmailTemplateSharingSalesUnitRelations.update summary: EmailTemplateSharingSalesUnitRelations.update tags: - Email requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateEmailTemplateSharingSalesUnitRelationInput' responses: '200': description: Modification confirmation. Returns resulting EmailTemplateSharingSalesUnitRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailTemplateSharingSalesUnitRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailTemplateSharingSalesUnitRelations: get: description: Returns all defined EmailTemplateSharingSalesUnitRelations operationId: EmailTemplateSharingSalesUnitRelations.list summary: EmailTemplateSharingSalesUnitRelations.list tags: - Email parameters: - name: include-deleted in: query description: if enabled, deleted EmailTemplateSharingSalesUnitRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of EmailTemplateSharingSalesUnitRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/EmailTemplateSharingSalesUnitRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new EmailTemplateSharingSalesUnitRelation operationId: EmailTemplateSharingSalesUnitRelations.create summary: EmailTemplateSharingSalesUnitRelations.create tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailTemplateSharingSalesUnitRelation on create. Use them as bit mask: 0 - validate each field on entity, 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 EmailTemplateSharingSalesUnitRelation required: true content: application / json: schema: $ref: '#/components/schemas/createEmailTemplateSharingSalesUnitRelationInput' responses: '201': description: Creation confirmation. Returns created EmailTemplateSharingSalesUnitRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailTemplateSharingSalesUnitRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailTemplateSharingSalesUnitRelations/batch-delete: post: description: Removes EmailTemplateSharingSalesUnitRelations with given list of ids operationId: EmailTemplateSharingSalesUnitRelations.batch_delete summary: EmailTemplateSharingSalesUnitRelations.batch_delete tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailTemplateSharingSalesUnitRelations on delete. Use them as bit mask: 0 - validate each field on entity, 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 EmailTemplateSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity EmailTemplateSharingSalesUnitRelation to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted EmailTemplateSharingSalesUnitRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailTemplateSharingSalesUnitRelations/batch-modify: post: description: Create or update an batch of EmailTemplateSharingSalesUnitRelations operationId: EmailTemplateSharingSalesUnitRelations.batch_create_or_update summary: EmailTemplateSharingSalesUnitRelations.batch_create_or_update tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailTemplateSharingSalesUnitRelations on change. Use them as bit mask: 0 - validate each field on entity, 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 EmailTemplateSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new EmailTemplateSharingSalesUnitRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchEmailTemplateSharingSalesUnitRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated EmailTemplateSharingSalesUnitRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailTemplateSharingSalesUnitRelations/batch-restore: post: description: Restores EmailTemplateSharingSalesUnitRelations with given list of ids operationId: EmailTemplateSharingSalesUnitRelations.batch_restore summary: EmailTemplateSharingSalesUnitRelations.batch_restore tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailTemplateSharingSalesUnitRelations on restore. Use them as bit mask: 0 - validate each field on entity, 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 EmailTemplateSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity EmailTemplateSharingSalesUnitRelation to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored EmailTemplateSharingSalesUnitRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailThreadMailboxClientReadStates/{id}: get: description: Returns EmailThreadMailboxClientReadState with given id operationId: EmailThreadMailboxClientReadStates.get summary: EmailThreadMailboxClientReadStates.get tags: - Email parameters: - name: id in: path description: ID of EmailThreadMailboxClientReadState to retrieve required: true schema: type: string format: uuid responses: '200': description: EmailThreadMailboxClientReadState data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailThreadMailboxClientReadState' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes EmailThreadMailboxClientReadState with given id operationId: EmailThreadMailboxClientReadStates.delete summary: EmailThreadMailboxClientReadStates.delete tags: - Email parameters: - name: id in: path description: ID of EmailThreadMailboxClientReadState to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of EmailThreadMailboxClientReadState on delete. Use them as bit mask: 0 - validate each field on entity, 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 EmailThreadMailboxClientReadState type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies EmailThreadMailboxClientReadState or EmailThreadMailboxClientReadStates with given id(s) parameters: - name: id in: path description: ID of EmailThreadMailboxClientReadState to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of EmailThreadMailboxClientReadState on update. Use them as bit mask: 0 - validate each field on entity, 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: EmailThreadMailboxClientReadStates.update summary: EmailThreadMailboxClientReadStates.update tags: - Email requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateEmailThreadMailboxClientReadStateInput' responses: '200': description: Modification confirmation. Returns resulting EmailThreadMailboxClientReadState content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailThreadMailboxClientReadState' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailThreadMailboxClientReadStates: get: description: Returns all defined EmailThreadMailboxClientReadStates operationId: EmailThreadMailboxClientReadStates.list summary: EmailThreadMailboxClientReadStates.list tags: - Email parameters: - name: include-deleted in: query description: if enabled, deleted EmailThreadMailboxClientReadStates are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of EmailThreadMailboxClientReadStates content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/EmailThreadMailboxClientReadState' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new EmailThreadMailboxClientReadState operationId: EmailThreadMailboxClientReadStates.create summary: EmailThreadMailboxClientReadStates.create tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailThreadMailboxClientReadState on create. Use them as bit mask: 0 - validate each field on entity, 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 EmailThreadMailboxClientReadState required: true content: application / json: schema: $ref: '#/components/schemas/createEmailThreadMailboxClientReadStateInput' responses: '201': description: Creation confirmation. Returns created EmailThreadMailboxClientReadState content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EmailThreadMailboxClientReadState' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailThreadMailboxClientReadStates/batch-delete: post: description: Removes EmailThreadMailboxClientReadStates with given list of ids operationId: EmailThreadMailboxClientReadStates.batch_delete summary: EmailThreadMailboxClientReadStates.batch_delete tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailThreadMailboxClientReadStates on delete. Use them as bit mask: 0 - validate each field on entity, 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 EmailThreadMailboxClientReadStates. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity EmailThreadMailboxClientReadState to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted EmailThreadMailboxClientReadState. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailThreadMailboxClientReadStates/batch-modify: post: description: Create or update an batch of EmailThreadMailboxClientReadStates operationId: EmailThreadMailboxClientReadStates.batch_create_or_update summary: EmailThreadMailboxClientReadStates.batch_create_or_update tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailThreadMailboxClientReadStates on change. Use them as bit mask: 0 - validate each field on entity, 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 EmailThreadMailboxClientReadStates. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new EmailThreadMailboxClientReadState required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchEmailThreadMailboxClientReadStateInput' responses: '200': description: Creation confirmation. Returns a list of created / updated EmailThreadMailboxClientReadStates content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EmailThreadMailboxClientReadStates/batch-restore: post: description: Restores EmailThreadMailboxClientReadStates with given list of ids operationId: EmailThreadMailboxClientReadStates.batch_restore summary: EmailThreadMailboxClientReadStates.batch_restore tags: - Email parameters: - name: validation-level in: query description: 'Specify validation level of EmailThreadMailboxClientReadStates on restore. Use them as bit mask: 0 - validate each field on entity, 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 EmailThreadMailboxClientReadStates. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity EmailThreadMailboxClientReadState to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored EmailThreadMailboxClientReadState. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: batchEmailContentSharingClientRelationInput: properties: client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid createEmailTemplateSharingClientRelationInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. email_template_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email template. role: type: integer description: 'Sharing role granting the user a specific access level (e.g. Read, Edit) on the template. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - client_id - email_template_id EmailTemplateSharingSalesUnitRelation: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true email_template: type: string format: uri description: 'Email template being shared. Relation to EmailTemplate. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''EmailTemplate'' object for properties.' unit: type: string format: uri description: 'Sales unit the template is shared with. 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.' email_template_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email template. role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the template. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - email_template - unit - email_template_id - unit_id createEmailMailboxRelationInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true direction: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - OutgoingEmail, 2 - IncomingEmail' example: 1 enum: - 1 - 2 email_created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email that belongs to the mailbox. email_is_deleted: type: boolean example: false description: Denormalized flag indicating that the related email has been deleted from this mailbox; such relations are hidden from the inbox view. error_code: type: integer format: int32 example: 1 description: Error code for the email in this mailbox; 0 means the email was processed without error. event_types: type: string example: 2 enum: - 2 - 4 - 8 - 16 - 32 - 64 description: Field whose values are strictly defined with an enumeration of values. is_scheduled: type: boolean example: false description: Whether the email is scheduled to be sent at a future time and has not been sent yet. mailbox_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the mailbox (connected email account) the email belongs to. sent_or_scheduled_at: type: string format: date-time example: '2019-01-01T00:00:00' description: Time when the email was sent, or its scheduled send time if it has not been sent yet. thread_or_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email thread, or the id of the email itself when it does not belong to a thread. type: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Standard, 2 - Mass' example: 1 enum: - 1 - 2 required: - email_id - mailbox_id updateEmailTemplateInput: properties: body: type: string example: string description: HTML body of the template. May use merge-field placeholders that are filled with record values when the template is composed. email_template_folder_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the folder. name: type: string example: string description: Name of the entity and its default text representation. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the template owner. recent_colors: type: object description: List of integers. share_mode: type: integer description: 'Sharing model for the template (e.g. shared with selected sales units, selected users, or open for editing by all). Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit' example: 0 enum: - 0 - 1 - 2 - 3 sharing_url_is_enabled: type: boolean example: false description: When true, the template's public sharing URL is active and accessible. Setting to false invalidates outstanding sharing URLs. sharing_url_settings: type: object description: 'Public sharing-link configuration: resolved URL plus optional personalisation context (entity type, entity id) used to pre-fill merge fields. Empty when no sharing link is configured.' subject: type: string example: string description: Subject line of emails composed from this template. Supports merge-field placeholders. type: type: integer description: 'Template format (e.g. HtmlTemplate, PlainTextTemplate). Integer enum value: 0 - TextTemplate, 1 - HtmlTemplate, 2 - WysiwygTemplate' example: 0 enum: - 0 - 1 - 2 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to EmailTemplateSharingSalesUnitRelation, see: ''updateEmailTemplateSharingSalesUnitRelationInput'' object for properties.' description: Sales units granted shared access to this template (custom share mode). sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to EmailTemplateSharingClientRelation, see: ''updateEmailTemplateSharingClientRelationInput'' object for properties.' description: Users granted shared access to this template (custom share mode). documents: type: array items: type: object properties: id: type: string format: uri description: 'Relation to CloudObjectRelation, see: ''updateCloudObjectRelationInput'' object for properties.' description: Files attached to the template (used as default attachments). updateEmailContentSharingSalesUnitRelationInput: properties: email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. updateEmailTemplateSharingClientRelationInput: properties: client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. email_template_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email template. role: type: integer description: 'Sharing role granting the user a specific access level (e.g. Read, Edit) on the template. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. 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 updateEmailTemplateFolderInput: properties: name: type: string example: string description: Name of the entity and its default text representation. parent_email_template_folder_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent folder. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. batchEmailTemplateSharingSalesUnitRelationInput: properties: email_template_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email template. role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the template. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid EmailEvent: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true email: type: string format: uri description: 'Email message the event was reported for. Relation to Email. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Email'' object for properties.' additional_data: type: object description: Provider-specific extra data captured with the event (e.g. user agent, ip), as a JSON document. email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email message. type: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Open, 2 - Click, 3 - Unsubscribe, 4 - Bounce, 5 - Reply, 6 - BounceSoft' example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 url: type: string example: string description: URL the recipient interacted with. Set for click events; empty for other event types. required: - is_delete_protected - id - email - email_id Email: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true company_email: type: string format: uri description: 'Configured company email used as the From / Reply-To. Empty when sent from the user mailbox. 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.' owner: type: string format: uri description: 'Sales user who owns this email. May be empty for unassigned emails. 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.' parent_email: type: string format: uri description: 'For mass emails: the master email this copy was generated from. Empty for the master and for non-mass emails. Relation to Email. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Email'' object for properties.' sender_account: type: string format: uri description: 'Account record matched as the sender, or empty when the sender does not match an existing Account. 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.' sender_client: type: string format: uri description: 'Internal user matched as the sender, or empty when the sender is external. 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.' sender_contact: type: string format: uri description: 'Contact record matched as the sender, or empty when the sender does not match an existing 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.' template: type: string format: uri description: 'Email template used to compose this email, or empty when none was used. Relation to EmailTemplate. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''EmailTemplate'' object for properties.' additional_headers: type: object description: Extra raw email headers preserved from the source message, as a JSON object mapping each header name to a string or a list of strings. body: type: string example: string description: HTML body of the email. Returned only to users with read permission on the email content; otherwise empty. body_summary: type: string example: string description: Plain-text summary of the email body. Returned only to users with read permission on the email content; otherwise empty. cc: type: string example: string description: Comma-separated list of carbon-copy recipients. company_email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the company email. content_share_mode: type: integer description: 'How the email body is shared with non-owners (e.g. Private hides the body, Public makes it visible to anyone with read access on the email envelope). Integer enum value: 0 - Custom, 1 - Private, 2 - Public' example: 0 enum: - 0 - 1 - 2 content_type: type: string example: string description: MIME content type of the body (e.g. text/html, text/plain). date_sent: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp the email was sent. Empty for drafts and scheduled emails not yet sent. direction: type: integer description: 'Direction of the email (Incoming, Outgoing). Integer enum value: 1 - OutgoingEmail, 2 - IncomingEmail' example: 1 enum: - 1 - 2 error_code: type: integer format: int32 example: 1 description: Numeric error code recorded when the email failed to send. Zero when no error occurred. is_tracked: type: boolean example: false description: True when delivery tracking is enabled. Tracked emails generate EmailEvent records on open/click. original_id: type: string example: string description: External identifier of the email on the source mailbox (e.g. IMAP Message-ID). Used to deduplicate when re-syncing. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email owner. parent_email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent (master) email. schedule_settings: type: object description: Scheduling configuration for delayed sending, as a JSON object; next_schedule is a numeric timestamp and recipients/cc/bcc are lists. send_at: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp at which a scheduled email is queued to be sent. Empty for immediately-sent emails. sender: type: string example: string description: Sender address as it appeared on the email (free-text "From" header). sender_account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the matched sender account. sender_client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the matched sender user. sender_contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the matched sender contact. sentiment: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - Negative, 1 - Neutral, 2 - Positive' example: 0 enum: - 0 - 1 - 2 share_mode: type: integer description: 'Sharing model for the email envelope (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access. Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit' example: 0 enum: - 0 - 1 - 2 - 3 subject: type: string example: string description: Name of the entity and its default text representation. table_name: type: string example: string description: Discriminator identifying the concrete record type — always "email" for Email records. Read-only; useful when consuming polymorphic Message results. readOnly: true template_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email template. thread_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Identifier grouping emails belonging to the same conversation thread. to: type: string example: string description: Comma-separated list of primary recipients. type: type: integer description: 'Email category (e.g. regular email, mass email, calendar invitation). Integer enum value: 1 - Standard, 2 - Mass' example: 1 enum: - 1 - 2 uid: type: string example: string description: IMAP UID of the email on the source mailbox. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. is_favorite: type: boolean example: false description: True when the current authenticated user has marked this email as favorite. Per-user. sharing_units: type: array items: type: string format: uri description: 'Relation to MessageSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''MessageSharingSalesUnitRelation'' object for properties.' description: Sales units that have been granted shared access to this email envelope. sharing_clients: type: array items: type: string format: uri description: 'Relation to MessageSharingClientRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''MessageSharingClientRelation'' object for properties.' description: Users that have been granted shared access to this email envelope. content_sharing_units: type: array items: type: string format: uri description: 'Relation to EmailContentSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''EmailContentSharingSalesUnitRelation'' object for properties.' description: Sales units that have been granted access to the email body when content_share_mode is restricted. content_sharing_clients: type: array items: type: string format: uri description: 'Relation to EmailContentSharingClientRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''EmailContentSharingClientRelation'' object for properties.' description: Users that have been granted access to the email body when content_share_mode is restricted. account_relations: type: array items: type: string format: uri description: 'Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''MessageRelation'' object for properties.' description: Accounts this email is linked to. contact_relations: type: array items: type: string format: uri description: 'Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''MessageRelation'' object for properties.' description: Contacts this email is linked to. project_relations: type: array items: type: string format: uri description: 'Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''MessageRelation'' object for properties.' description: Projects this email is linked to. custom_entity_relations: type: array items: type: string format: uri description: 'Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''MessageRelation'' object for properties.' description: Custom entity records this email is linked to. lead_relations: type: array items: type: string format: uri description: 'Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''MessageRelation'' object for properties.' description: Leads this email is linked to. opportunity_relations: type: array items: type: string format: uri description: 'Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''MessageRelation'' object for properties.' description: Opportunities this email is linked to. quote_relations: type: array items: type: string format: uri description: 'Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''MessageRelation'' object for properties.' description: Quotes this email is linked to. tags: type: array items: type: string format: uri description: 'Relation to TagRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''TagRelation'' object for properties.' description: Tag labels applied to this email. Visible only to users that can read the email body. documents: type: array items: type: string format: uri description: 'Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''CloudObjectRelation'' object for properties.' description: Attachments and other documents linked to this email. mailbox_ids: type: array items: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Ids of the mailboxes (company or personal) the email envelope belongs to, aggregated from the active email_mailbox_relation rows. required: - is_delete_protected - id - direction - table_name - uid - is_favorite - mailbox_ids createEmailInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true additional_headers: type: object description: Extra raw email headers preserved from the source message, as a JSON object mapping each header name to a string or a list of strings. body: type: string example: string description: HTML body of the email. Returned only to users with read permission on the email content; otherwise empty. body_summary: type: string example: string description: Plain-text summary of the email body. Returned only to users with read permission on the email content; otherwise empty. cc: type: string example: string description: Comma-separated list of carbon-copy recipients. company_email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the company email. content_share_mode: type: integer description: 'How the email body is shared with non-owners (e.g. Private hides the body, Public makes it visible to anyone with read access on the email envelope). Integer enum value: 0 - Custom, 1 - Private, 2 - Public' example: 0 enum: - 0 - 1 - 2 content_type: type: string example: string description: MIME content type of the body (e.g. text/html, text/plain). date_sent: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp the email was sent. Empty for drafts and scheduled emails not yet sent. direction: type: integer description: 'Direction of the email (Incoming, Outgoing). Integer enum value: 1 - OutgoingEmail, 2 - IncomingEmail' example: 1 enum: - 1 - 2 error_code: type: integer format: int32 example: 1 description: Numeric error code recorded when the email failed to send. Zero when no error occurred. is_tracked: type: boolean example: false description: True when delivery tracking is enabled. Tracked emails generate EmailEvent records on open/click. original_id: type: string example: string description: External identifier of the email on the source mailbox (e.g. IMAP Message-ID). Used to deduplicate when re-syncing. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email owner. parent_email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent (master) email. schedule_settings: type: object description: Scheduling configuration for delayed sending, as a JSON object; next_schedule is a numeric timestamp and recipients/cc/bcc are lists. send_at: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp at which a scheduled email is queued to be sent. Empty for immediately-sent emails. sender: type: string example: string description: Sender address as it appeared on the email (free-text "From" header). sender_account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the matched sender account. sender_client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the matched sender user. sender_contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the matched sender contact. sentiment: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - Negative, 1 - Neutral, 2 - Positive' example: 0 enum: - 0 - 1 - 2 share_mode: type: integer description: 'Sharing model for the email envelope (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access. Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit' example: 0 enum: - 0 - 1 - 2 - 3 subject: type: string example: string description: Name of the entity and its default text representation. template_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email template. thread_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Identifier grouping emails belonging to the same conversation thread. to: type: string example: string description: Comma-separated list of primary recipients. type: type: integer description: 'Email category (e.g. regular email, mass email, calendar invitation). Integer enum value: 1 - Standard, 2 - Mass' example: 1 enum: - 1 - 2 uid: type: string example: string description: IMAP UID of the email on the source mailbox. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageSharingSalesUnitRelation, see: ''createMessageSharingSalesUnitRelationInput'' object for properties.' description: Sales units that have been granted shared access to this email envelope. sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageSharingClientRelation, see: ''createMessageSharingClientRelationInput'' object for properties.' description: Users that have been granted shared access to this email envelope. content_sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to EmailContentSharingSalesUnitRelation, see: ''createEmailContentSharingSalesUnitRelationInput'' object for properties.' description: Sales units that have been granted access to the email body when content_share_mode is restricted. content_sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to EmailContentSharingClientRelation, see: ''createEmailContentSharingClientRelationInput'' object for properties.' description: Users that have been granted access to the email body when content_share_mode is restricted. account_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageRelation, see: ''createMessageRelationInput'' object for properties.' description: Accounts this email is linked to. contact_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageRelation, see: ''createMessageRelationInput'' object for properties.' description: Contacts this email is linked to. project_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageRelation, see: ''createMessageRelationInput'' object for properties.' description: Projects this email is linked to. custom_entity_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageRelation, see: ''createMessageRelationInput'' object for properties.' description: Custom entity records this email is linked to. lead_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageRelation, see: ''createMessageRelationInput'' object for properties.' description: Leads this email is linked to. opportunity_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageRelation, see: ''createMessageRelationInput'' object for properties.' description: Opportunities this email is linked to. quote_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageRelation, see: ''createMessageRelationInput'' object for properties.' description: Quotes this email is linked to. tags: type: array items: type: object properties: id: type: string format: uri description: 'Relation to TagRelation, see: ''createTagRelationInput'' object for properties.' description: Tag labels applied to this email. Visible only to users that can read the email body. documents: type: array items: type: object properties: id: type: string format: uri description: 'Relation to CloudObjectRelation, see: ''createCloudObjectRelationInput'' object for properties.' description: Attachments and other documents linked to this email. required: - direction - uid createEmailTemplateSharingSalesUnitRelationInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true email_template_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email template. role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the template. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - email_template_id - unit_id updateEmailMailboxRelationInput: properties: direction: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - OutgoingEmail, 2 - IncomingEmail' example: 1 enum: - 1 - 2 email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email that belongs to the mailbox. email_is_deleted: type: boolean example: false description: Denormalized flag indicating that the related email has been deleted from this mailbox; such relations are hidden from the inbox view. error_code: type: integer format: int32 example: 1 description: Error code for the email in this mailbox; 0 means the email was processed without error. event_types: type: string example: 2 enum: - 2 - 4 - 8 - 16 - 32 - 64 description: Field whose values are strictly defined with an enumeration of values. is_scheduled: type: boolean example: false description: Whether the email is scheduled to be sent at a future time and has not been sent yet. mailbox_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the mailbox (connected email account) the email belongs to. sent_or_scheduled_at: type: string format: date-time example: '2019-01-01T00:00:00' description: Time when the email was sent, or its scheduled send time if it has not been sent yet. thread_or_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email thread, or the id of the email itself when it does not belong to a thread. type: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Standard, 2 - Mass' example: 1 enum: - 1 - 2 createEmailThreadMailboxClientReadStateInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user whose read state of the email thread is tracked. last_read_at: type: string format: date-time example: '2019-01-01T00:00:00' description: Time when the user last read the email thread in the mailbox. mailbox_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the mailbox (connected email account) the email thread belongs to. thread_or_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email thread, or the id of the email itself when it does not belong to a thread. required: - client_id - mailbox_id - thread_or_id batchEmailThreadMailboxClientReadStateInput: properties: client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user whose read state of the email thread is tracked. last_read_at: type: string format: date-time example: '2019-01-01T00:00:00' description: Time when the user last read the email thread in the mailbox. mailbox_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the mailbox (connected email account) the email thread belongs to. thread_or_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email thread, or the id of the email itself when it does not belong to a thread. id: description: ID of object to update. type: string format: uuid batchEmailTemplateFolderInput: properties: name: type: string example: string description: Name of the entity and its default text representation. parent_email_template_folder_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent folder. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid batchEmailTemplateInput: properties: body: type: string example: string description: HTML body of the template. May use merge-field placeholders that are filled with record values when the template is composed. email_template_folder_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the folder. name: type: string example: string description: Name of the entity and its default text representation. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the template owner. recent_colors: type: object description: List of integers. share_mode: type: integer description: 'Sharing model for the template (e.g. shared with selected sales units, selected users, or open for editing by all). Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit' example: 0 enum: - 0 - 1 - 2 - 3 sharing_url_is_enabled: type: boolean example: false description: When true, the template's public sharing URL is active and accessible. Setting to false invalidates outstanding sharing URLs. sharing_url_settings: type: object description: 'Public sharing-link configuration: resolved URL plus optional personalisation context (entity type, entity id) used to pre-fill merge fields. Empty when no sharing link is configured.' subject: type: string example: string description: Subject line of emails composed from this template. Supports merge-field placeholders. type: type: integer description: 'Template format (e.g. HtmlTemplate, PlainTextTemplate). Integer enum value: 0 - TextTemplate, 1 - HtmlTemplate, 2 - WysiwygTemplate' example: 0 enum: - 0 - 1 - 2 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to EmailTemplateSharingSalesUnitRelation, see: ''updateEmailTemplateSharingSalesUnitRelationInput'' object for properties.' description: Sales units granted shared access to this template (custom share mode). sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to EmailTemplateSharingClientRelation, see: ''updateEmailTemplateSharingClientRelationInput'' object for properties.' description: Users granted shared access to this template (custom share mode). documents: type: array items: type: object properties: id: type: string format: uri description: 'Relation to CloudObjectRelation, see: ''updateCloudObjectRelationInput'' object for properties.' description: Files attached to the template (used as default attachments). id: description: ID of object to update. type: string format: uuid batchEmailEventInput: properties: additional_data: type: object description: Provider-specific extra data captured with the event (e.g. user agent, ip), as a JSON document. email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email message. type: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Open, 2 - Click, 3 - Unsubscribe, 4 - Bounce, 5 - Reply, 6 - BounceSoft' example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 url: type: string example: string description: URL the recipient interacted with. Set for click events; empty for other event types. id: description: ID of object to update. type: string format: uuid batchEmailTemplateSharingClientRelationInput: properties: client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. email_template_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email template. role: type: integer description: 'Sharing role granting the user a specific access level (e.g. Read, Edit) on the template. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid updateEmailContentSharingClientRelationInput: properties: client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. updateEmailThreadMailboxClientReadStateInput: properties: client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user whose read state of the email thread is tracked. last_read_at: type: string format: date-time example: '2019-01-01T00:00:00' description: Time when the user last read the email thread in the mailbox. mailbox_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the mailbox (connected email account) the email thread belongs to. thread_or_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email thread, or the id of the email itself when it does not belong to a thread. EmailTemplateSharingClientRelation: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true client: type: string format: uri description: 'User the template is shared with. 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.' email_template: type: string format: uri description: 'Email template being shared. Relation to EmailTemplate. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''EmailTemplate'' object for properties.' client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. email_template_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email template. role: type: integer description: 'Sharing role granting the user a specific access level (e.g. Read, Edit) on the template. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - client - email_template - client_id - email_template_id batchEmailInput: properties: additional_headers: type: object description: Extra raw email headers preserved from the source message, as a JSON object mapping each header name to a string or a list of strings. body: type: string example: string description: HTML body of the email. Returned only to users with read permission on the email content; otherwise empty. body_summary: type: string example: string description: Plain-text summary of the email body. Returned only to users with read permission on the email content; otherwise empty. cc: type: string example: string description: Comma-separated list of carbon-copy recipients. company_email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the company email. content_share_mode: type: integer description: 'How the email body is shared with non-owners (e.g. Private hides the body, Public makes it visible to anyone with read access on the email envelope). Integer enum value: 0 - Custom, 1 - Private, 2 - Public' example: 0 enum: - 0 - 1 - 2 content_type: type: string example: string description: MIME content type of the body (e.g. text/html, text/plain). date_sent: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp the email was sent. Empty for drafts and scheduled emails not yet sent. direction: type: integer description: 'Direction of the email (Incoming, Outgoing). Integer enum value: 1 - OutgoingEmail, 2 - IncomingEmail' example: 1 enum: - 1 - 2 error_code: type: integer format: int32 example: 1 description: Numeric error code recorded when the email failed to send. Zero when no error occurred. is_tracked: type: boolean example: false description: True when delivery tracking is enabled. Tracked emails generate EmailEvent records on open/click. original_id: type: string example: string description: External identifier of the email on the source mailbox (e.g. IMAP Message-ID). Used to deduplicate when re-syncing. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email owner. parent_email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent (master) email. schedule_settings: type: object description: Scheduling configuration for delayed sending, as a JSON object; next_schedule is a numeric timestamp and recipients/cc/bcc are lists. send_at: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp at which a scheduled email is queued to be sent. Empty for immediately-sent emails. sender: type: string example: string description: Sender address as it appeared on the email (free-text "From" header). sender_account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the matched sender account. sender_client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the matched sender user. sender_contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the matched sender contact. sentiment: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - Negative, 1 - Neutral, 2 - Positive' example: 0 enum: - 0 - 1 - 2 share_mode: type: integer description: 'Sharing model for the email envelope (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access. Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit' example: 0 enum: - 0 - 1 - 2 - 3 subject: type: string example: string description: Name of the entity and its default text representation. template_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email template. thread_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Identifier grouping emails belonging to the same conversation thread. to: type: string example: string description: Comma-separated list of primary recipients. type: type: integer description: 'Email category (e.g. regular email, mass email, calendar invitation). Integer enum value: 1 - Standard, 2 - Mass' example: 1 enum: - 1 - 2 uid: type: string example: string description: IMAP UID of the email on the source mailbox. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageSharingSalesUnitRelation, see: ''updateMessageSharingSalesUnitRelationInput'' object for properties.' description: Sales units that have been granted shared access to this email envelope. sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageSharingClientRelation, see: ''updateMessageSharingClientRelationInput'' object for properties.' description: Users that have been granted shared access to this email envelope. content_sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to EmailContentSharingSalesUnitRelation, see: ''updateEmailContentSharingSalesUnitRelationInput'' object for properties.' description: Sales units that have been granted access to the email body when content_share_mode is restricted. content_sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to EmailContentSharingClientRelation, see: ''updateEmailContentSharingClientRelationInput'' object for properties.' description: Users that have been granted access to the email body when content_share_mode is restricted. account_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageRelation, see: ''updateMessageRelationInput'' object for properties.' description: Accounts this email is linked to. contact_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageRelation, see: ''updateMessageRelationInput'' object for properties.' description: Contacts this email is linked to. project_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageRelation, see: ''updateMessageRelationInput'' object for properties.' description: Projects this email is linked to. custom_entity_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageRelation, see: ''updateMessageRelationInput'' object for properties.' description: Custom entity records this email is linked to. lead_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageRelation, see: ''updateMessageRelationInput'' object for properties.' description: Leads this email is linked to. opportunity_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageRelation, see: ''updateMessageRelationInput'' object for properties.' description: Opportunities this email is linked to. quote_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageRelation, see: ''updateMessageRelationInput'' object for properties.' description: Quotes this email is linked to. tags: type: array items: type: object properties: id: type: string format: uri description: 'Relation to TagRelation, see: ''updateTagRelationInput'' object for properties.' description: Tag labels applied to this email. Visible only to users that can read the email body. documents: type: array items: type: object properties: id: type: string format: uri description: 'Relation to CloudObjectRelation, see: ''updateCloudObjectRelationInput'' object for properties.' description: Attachments and other documents linked to this email. id: description: ID of object to update. type: string format: uuid EmailMailboxRelation: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true email: type: string format: uri description: 'Email that belongs to the mailbox. Relation to Email. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Email'' object for properties.' direction: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - OutgoingEmail, 2 - IncomingEmail' example: 1 enum: - 1 - 2 email_created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email that belongs to the mailbox. email_is_deleted: type: boolean example: false description: Denormalized flag indicating that the related email has been deleted from this mailbox; such relations are hidden from the inbox view. error_code: type: integer format: int32 example: 1 description: Error code for the email in this mailbox; 0 means the email was processed without error. event_types: type: string example: 2 enum: - 2 - 4 - 8 - 16 - 32 - 64 description: Field whose values are strictly defined with an enumeration of values. is_scheduled: type: boolean example: false description: Whether the email is scheduled to be sent at a future time and has not been sent yet. mailbox_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the mailbox (connected email account) the email belongs to. sent_or_scheduled_at: type: string format: date-time example: '2019-01-01T00:00:00' description: Time when the email was sent, or its scheduled send time if it has not been sent yet. thread_or_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email thread, or the id of the email itself when it does not belong to a thread. type: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Standard, 2 - Mass' example: 1 enum: - 1 - 2 required: - is_delete_protected - id - email - email_id - mailbox_id EmailContentSharingSalesUnitRelation: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true email: type: string format: uri description: 'Email whose body is being shared. Relation to Email. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Email'' object for properties.' unit: type: string format: uri description: 'Sales unit granted access to the email body. 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.' email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - email - unit - email_id - unit_id EmailTemplate: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true email_template_folder: type: string format: uri description: 'Folder in the template hierarchy that the template belongs to. Empty for templates at the root level. Relation to EmailTemplateFolder. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''EmailTemplateFolder'' object for properties.' owner: type: string format: uri description: 'User who owns the template. 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.' body: type: string example: string description: HTML body of the template. May use merge-field placeholders that are filled with record values when the template is composed. email_template_folder_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the folder. name: type: string example: string description: Name of the entity and its default text representation. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the template owner. recent_colors: type: object description: List of integers. share_mode: type: integer description: 'Sharing model for the template (e.g. shared with selected sales units, selected users, or open for editing by all). Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit' example: 0 enum: - 0 - 1 - 2 - 3 sharing_url_is_enabled: type: boolean example: false description: When true, the template's public sharing URL is active and accessible. Setting to false invalidates outstanding sharing URLs. sharing_url_settings: type: object description: 'Public sharing-link configuration: resolved URL plus optional personalisation context (entity type, entity id) used to pre-fill merge fields. Empty when no sharing link is configured.' subject: type: string example: string description: Subject line of emails composed from this template. Supports merge-field placeholders. type: type: integer description: 'Template format (e.g. HtmlTemplate, PlainTextTemplate). Integer enum value: 0 - TextTemplate, 1 - HtmlTemplate, 2 - WysiwygTemplate' example: 0 enum: - 0 - 1 - 2 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. sharing_units: type: array items: type: string format: uri description: 'Relation to EmailTemplateSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''EmailTemplateSharingSalesUnitRelation'' object for properties.' description: Sales units granted shared access to this template (custom share mode). sharing_clients: type: array items: type: string format: uri description: 'Relation to EmailTemplateSharingClientRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''EmailTemplateSharingClientRelation'' object for properties.' description: Users granted shared access to this template (custom share mode). documents: type: array items: type: string format: uri description: 'Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''CloudObjectRelation'' object for properties.' description: Files attached to the template (used as default attachments). required: - is_delete_protected - id - owner - name - owner_id - subject - type batchEmailContentSharingSalesUnitRelationInput: properties: email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid EmailTemplateFolder: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true parent_email_template_folder: type: string format: uri description: 'Parent folder in the template hierarchy. Empty for top-level folders. Relation to EmailTemplateFolder. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''EmailTemplateFolder'' object for properties.' name: type: string example: string description: Name of the entity and its default text representation. parent_email_template_folder_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent folder. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - name updateEmailInput: properties: additional_headers: type: object description: Extra raw email headers preserved from the source message, as a JSON object mapping each header name to a string or a list of strings. body: type: string example: string description: HTML body of the email. Returned only to users with read permission on the email content; otherwise empty. body_summary: type: string example: string description: Plain-text summary of the email body. Returned only to users with read permission on the email content; otherwise empty. cc: type: string example: string description: Comma-separated list of carbon-copy recipients. company_email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the company email. content_share_mode: type: integer description: 'How the email body is shared with non-owners (e.g. Private hides the body, Public makes it visible to anyone with read access on the email envelope). Integer enum value: 0 - Custom, 1 - Private, 2 - Public' example: 0 enum: - 0 - 1 - 2 content_type: type: string example: string description: MIME content type of the body (e.g. text/html, text/plain). date_sent: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp the email was sent. Empty for drafts and scheduled emails not yet sent. direction: type: integer description: 'Direction of the email (Incoming, Outgoing). Integer enum value: 1 - OutgoingEmail, 2 - IncomingEmail' example: 1 enum: - 1 - 2 error_code: type: integer format: int32 example: 1 description: Numeric error code recorded when the email failed to send. Zero when no error occurred. is_tracked: type: boolean example: false description: True when delivery tracking is enabled. Tracked emails generate EmailEvent records on open/click. original_id: type: string example: string description: External identifier of the email on the source mailbox (e.g. IMAP Message-ID). Used to deduplicate when re-syncing. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email owner. parent_email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent (master) email. schedule_settings: type: object description: Scheduling configuration for delayed sending, as a JSON object; next_schedule is a numeric timestamp and recipients/cc/bcc are lists. send_at: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp at which a scheduled email is queued to be sent. Empty for immediately-sent emails. sender: type: string example: string description: Sender address as it appeared on the email (free-text "From" header). sender_account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the matched sender account. sender_client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the matched sender user. sender_contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the matched sender contact. sentiment: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - Negative, 1 - Neutral, 2 - Positive' example: 0 enum: - 0 - 1 - 2 share_mode: type: integer description: 'Sharing model for the email envelope (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access. Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit' example: 0 enum: - 0 - 1 - 2 - 3 subject: type: string example: string description: Name of the entity and its default text representation. template_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email template. thread_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Identifier grouping emails belonging to the same conversation thread. to: type: string example: string description: Comma-separated list of primary recipients. type: type: integer description: 'Email category (e.g. regular email, mass email, calendar invitation). Integer enum value: 1 - Standard, 2 - Mass' example: 1 enum: - 1 - 2 uid: type: string example: string description: IMAP UID of the email on the source mailbox. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageSharingSalesUnitRelation, see: ''updateMessageSharingSalesUnitRelationInput'' object for properties.' description: Sales units that have been granted shared access to this email envelope. sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageSharingClientRelation, see: ''updateMessageSharingClientRelationInput'' object for properties.' description: Users that have been granted shared access to this email envelope. content_sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to EmailContentSharingSalesUnitRelation, see: ''updateEmailContentSharingSalesUnitRelationInput'' object for properties.' description: Sales units that have been granted access to the email body when content_share_mode is restricted. content_sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to EmailContentSharingClientRelation, see: ''updateEmailContentSharingClientRelationInput'' object for properties.' description: Users that have been granted access to the email body when content_share_mode is restricted. account_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageRelation, see: ''updateMessageRelationInput'' object for properties.' description: Accounts this email is linked to. contact_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageRelation, see: ''updateMessageRelationInput'' object for properties.' description: Contacts this email is linked to. project_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageRelation, see: ''updateMessageRelationInput'' object for properties.' description: Projects this email is linked to. custom_entity_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageRelation, see: ''updateMessageRelationInput'' object for properties.' description: Custom entity records this email is linked to. lead_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageRelation, see: ''updateMessageRelationInput'' object for properties.' description: Leads this email is linked to. opportunity_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageRelation, see: ''updateMessageRelationInput'' object for properties.' description: Opportunities this email is linked to. quote_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to MessageRelation, see: ''updateMessageRelationInput'' object for properties.' description: Quotes this email is linked to. tags: type: array items: type: object properties: id: type: string format: uri description: 'Relation to TagRelation, see: ''updateTagRelationInput'' object for properties.' description: Tag labels applied to this email. Visible only to users that can read the email body. documents: type: array items: type: object properties: id: type: string format: uri description: 'Relation to CloudObjectRelation, see: ''updateCloudObjectRelationInput'' object for properties.' description: Attachments and other documents linked to this email. updateEmailTemplateSharingSalesUnitRelationInput: properties: email_template_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email template. role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the template. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. createEmailContentSharingSalesUnitRelationInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - email_id - unit_id EmailContentSharingClientRelation: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true client: type: string format: uri description: 'User granted access to the email body. 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.' email: type: string format: uri description: 'Email whose body is being shared. Relation to Email. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Email'' object for properties.' client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - client - email - client_id - email_id batchEmailMailboxRelationInput: properties: direction: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - OutgoingEmail, 2 - IncomingEmail' example: 1 enum: - 1 - 2 email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email that belongs to the mailbox. email_is_deleted: type: boolean example: false description: Denormalized flag indicating that the related email has been deleted from this mailbox; such relations are hidden from the inbox view. error_code: type: integer format: int32 example: 1 description: Error code for the email in this mailbox; 0 means the email was processed without error. event_types: type: string example: 2 enum: - 2 - 4 - 8 - 16 - 32 - 64 description: Field whose values are strictly defined with an enumeration of values. is_scheduled: type: boolean example: false description: Whether the email is scheduled to be sent at a future time and has not been sent yet. mailbox_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the mailbox (connected email account) the email belongs to. sent_or_scheduled_at: type: string format: date-time example: '2019-01-01T00:00:00' description: Time when the email was sent, or its scheduled send time if it has not been sent yet. thread_or_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email thread, or the id of the email itself when it does not belong to a thread. type: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Standard, 2 - Mass' example: 1 enum: - 1 - 2 id: description: ID of object to update. type: string format: uuid createEmailTemplateInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true body: type: string example: string description: HTML body of the template. May use merge-field placeholders that are filled with record values when the template is composed. email_template_folder_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the folder. name: type: string example: string description: Name of the entity and its default text representation. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the template owner. recent_colors: type: object description: List of integers. share_mode: type: integer description: 'Sharing model for the template (e.g. shared with selected sales units, selected users, or open for editing by all). Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit' example: 0 enum: - 0 - 1 - 2 - 3 sharing_url_is_enabled: type: boolean example: false description: When true, the template's public sharing URL is active and accessible. Setting to false invalidates outstanding sharing URLs. sharing_url_settings: type: object description: 'Public sharing-link configuration: resolved URL plus optional personalisation context (entity type, entity id) used to pre-fill merge fields. Empty when no sharing link is configured.' subject: type: string example: string description: Subject line of emails composed from this template. Supports merge-field placeholders. type: type: integer description: 'Template format (e.g. HtmlTemplate, PlainTextTemplate). Integer enum value: 0 - TextTemplate, 1 - HtmlTemplate, 2 - WysiwygTemplate' example: 0 enum: - 0 - 1 - 2 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to EmailTemplateSharingSalesUnitRelation, see: ''createEmailTemplateSharingSalesUnitRelationInput'' object for properties.' description: Sales units granted shared access to this template (custom share mode). sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to EmailTemplateSharingClientRelation, see: ''createEmailTemplateSharingClientRelationInput'' object for properties.' description: Users granted shared access to this template (custom share mode). documents: type: array items: type: object properties: id: type: string format: uri description: 'Relation to CloudObjectRelation, see: ''createCloudObjectRelationInput'' object for properties.' description: Files attached to the template (used as default attachments). required: - name - owner_id - subject - type createEmailTemplateFolderInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true name: type: string example: string description: Name of the entity and its default text representation. parent_email_template_folder_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent folder. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - name createEmailEventInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true additional_data: type: object description: Provider-specific extra data captured with the event (e.g. user agent, ip), as a JSON document. email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email message. type: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Open, 2 - Click, 3 - Unsubscribe, 4 - Bounce, 5 - Reply, 6 - BounceSoft' example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 url: type: string example: string description: URL the recipient interacted with. Set for click events; empty for other event types. required: - email_id EmailThreadMailboxClientReadState: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true client: type: string format: uri description: 'User whose read state of the email thread is tracked. Relation to Client. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Client'' object for properties.' client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user whose read state of the email thread is tracked. last_read_at: type: string format: date-time example: '2019-01-01T00:00:00' description: Time when the user last read the email thread in the mailbox. mailbox_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the mailbox (connected email account) the email thread belongs to. thread_or_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email thread, or the id of the email itself when it does not belong to a thread. required: - is_delete_protected - id - client - client_id - mailbox_id - thread_or_id updateEmailEventInput: properties: additional_data: type: object description: Provider-specific extra data captured with the event (e.g. user agent, ip), as a JSON document. email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email message. type: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Open, 2 - Click, 3 - Unsubscribe, 4 - Bounce, 5 - Reply, 6 - BounceSoft' example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 url: type: string example: string description: URL the recipient interacted with. Set for click events; empty for other event types. createEmailContentSharingClientRelationInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - client_id - email_id