openapi: 3.2.0 info: title: Pipeliner Cloud Online 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: Online paths: /entities/OnlineForms/{id}: get: description: Returns OnlineForm with given id operationId: OnlineForms.get summary: OnlineForms.get tags: - Online parameters: - name: id in: path description: ID of OnlineForm to retrieve required: true schema: type: string format: uuid responses: '200': description: OnlineForm data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OnlineForm' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes OnlineForm with given id operationId: OnlineForms.delete summary: OnlineForms.delete tags: - Online parameters: - name: id in: path description: ID of OnlineForm to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OnlineForm on delete. Use them as bit mask: 0 - validate each field on entity, 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 OnlineForm type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies OnlineForm or OnlineForms with given id(s) parameters: - name: id in: path description: ID of OnlineForm to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OnlineForm on update. Use them as bit mask: 0 - validate each field on entity, 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: OnlineForms.update summary: OnlineForms.update tags: - Online requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateOnlineFormInput' responses: '200': description: Modification confirmation. Returns resulting OnlineForm content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OnlineForm' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineForms: get: description: Returns all defined OnlineForms operationId: OnlineForms.list summary: OnlineForms.list tags: - Online parameters: - name: include-deleted in: query description: if enabled, deleted OnlineForms are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OnlineForms content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/OnlineForm' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new OnlineForm operationId: OnlineForms.create summary: OnlineForms.create tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineForm on create. Use them as bit mask: 0 - validate each field on entity, 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 OnlineForm required: true content: application / json: schema: $ref: '#/components/schemas/createOnlineFormInput' responses: '201': description: Creation confirmation. Returns created OnlineForm content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OnlineForm' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineForms/batch-delete: post: description: Removes OnlineForms with given list of ids operationId: OnlineForms.batch_delete summary: OnlineForms.batch_delete tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineForms on delete. Use them as bit mask: 0 - validate each field on entity, 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 OnlineForms. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity OnlineForm to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted OnlineForm. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineForms/batch-modify: post: description: Create or update an batch of OnlineForms operationId: OnlineForms.batch_create_or_update summary: OnlineForms.batch_create_or_update tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineForms on change. Use them as bit mask: 0 - validate each field on entity, 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 OnlineForms. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new OnlineForm required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchOnlineFormInput' responses: '200': description: Creation confirmation. Returns a list of created / updated OnlineForms content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineForms/batch-restore: post: description: Restores OnlineForms with given list of ids operationId: OnlineForms.batch_restore summary: OnlineForms.batch_restore tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineForms on restore. Use them as bit mask: 0 - validate each field on entity, 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 OnlineForms. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity OnlineForm to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored OnlineForm. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormActivityLogLines/{id}: get: description: Returns OnlineFormActivityLogLine with given id operationId: OnlineFormActivityLogLines.get summary: OnlineFormActivityLogLines.get tags: - Online parameters: - name: id in: path description: ID of OnlineFormActivityLogLine to retrieve required: true schema: type: string format: uuid responses: '200': description: OnlineFormActivityLogLine data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OnlineFormActivityLogLine' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes OnlineFormActivityLogLine with given id operationId: OnlineFormActivityLogLines.delete summary: OnlineFormActivityLogLines.delete tags: - Online parameters: - name: id in: path description: ID of OnlineFormActivityLogLine to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OnlineFormActivityLogLine on delete. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormActivityLogLine type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies OnlineFormActivityLogLine or OnlineFormActivityLogLines with given id(s) parameters: - name: id in: path description: ID of OnlineFormActivityLogLine to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OnlineFormActivityLogLine on update. Use them as bit mask: 0 - validate each field on entity, 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: OnlineFormActivityLogLines.update summary: OnlineFormActivityLogLines.update tags: - Online requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateOnlineFormActivityLogLineInput' responses: '200': description: Modification confirmation. Returns resulting OnlineFormActivityLogLine content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OnlineFormActivityLogLine' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormActivityLogLines: get: description: Returns all defined OnlineFormActivityLogLines operationId: OnlineFormActivityLogLines.list summary: OnlineFormActivityLogLines.list tags: - Online parameters: - name: include-deleted in: query description: if enabled, deleted OnlineFormActivityLogLines are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OnlineFormActivityLogLines content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/OnlineFormActivityLogLine' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new OnlineFormActivityLogLine operationId: OnlineFormActivityLogLines.create summary: OnlineFormActivityLogLines.create tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineFormActivityLogLine on create. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormActivityLogLine required: true content: application / json: schema: $ref: '#/components/schemas/createOnlineFormActivityLogLineInput' responses: '201': description: Creation confirmation. Returns created OnlineFormActivityLogLine content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OnlineFormActivityLogLine' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormActivityLogLines/batch-delete: post: description: Removes OnlineFormActivityLogLines with given list of ids operationId: OnlineFormActivityLogLines.batch_delete summary: OnlineFormActivityLogLines.batch_delete tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineFormActivityLogLines on delete. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormActivityLogLines. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity OnlineFormActivityLogLine to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted OnlineFormActivityLogLine. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormActivityLogLines/batch-modify: post: description: Create or update an batch of OnlineFormActivityLogLines operationId: OnlineFormActivityLogLines.batch_create_or_update summary: OnlineFormActivityLogLines.batch_create_or_update tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineFormActivityLogLines on change. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormActivityLogLines. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new OnlineFormActivityLogLine required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchOnlineFormActivityLogLineInput' responses: '200': description: Creation confirmation. Returns a list of created / updated OnlineFormActivityLogLines content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormActivityLogLines/batch-restore: post: description: Restores OnlineFormActivityLogLines with given list of ids operationId: OnlineFormActivityLogLines.batch_restore summary: OnlineFormActivityLogLines.batch_restore tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineFormActivityLogLines on restore. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormActivityLogLines. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity OnlineFormActivityLogLine to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored OnlineFormActivityLogLine. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormDataExRelations/{id}: get: description: Returns OnlineFormDataExRelation with given id operationId: OnlineFormDataExRelations.get summary: OnlineFormDataExRelations.get tags: - Online parameters: - name: id in: path description: ID of OnlineFormDataExRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: OnlineFormDataExRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OnlineFormDataExRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes OnlineFormDataExRelation with given id operationId: OnlineFormDataExRelations.delete summary: OnlineFormDataExRelations.delete tags: - Online parameters: - name: id in: path description: ID of OnlineFormDataExRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OnlineFormDataExRelation on delete. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormDataExRelation type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies OnlineFormDataExRelation or OnlineFormDataExRelations with given id(s) parameters: - name: id in: path description: ID of OnlineFormDataExRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OnlineFormDataExRelation on update. Use them as bit mask: 0 - validate each field on entity, 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: OnlineFormDataExRelations.update summary: OnlineFormDataExRelations.update tags: - Online requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateOnlineFormDataExRelationInput' responses: '200': description: Modification confirmation. Returns resulting OnlineFormDataExRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OnlineFormDataExRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormDataExRelations: get: description: Returns all defined OnlineFormDataExRelations operationId: OnlineFormDataExRelations.list summary: OnlineFormDataExRelations.list tags: - Online parameters: - name: include-deleted in: query description: if enabled, deleted OnlineFormDataExRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OnlineFormDataExRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/OnlineFormDataExRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new OnlineFormDataExRelation operationId: OnlineFormDataExRelations.create summary: OnlineFormDataExRelations.create tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineFormDataExRelation on create. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormDataExRelation required: true content: application / json: schema: $ref: '#/components/schemas/createOnlineFormDataExRelationInput' responses: '201': description: Creation confirmation. Returns created OnlineFormDataExRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OnlineFormDataExRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormDataExRelations/batch-delete: post: description: Removes OnlineFormDataExRelations with given list of ids operationId: OnlineFormDataExRelations.batch_delete summary: OnlineFormDataExRelations.batch_delete tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineFormDataExRelations on delete. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormDataExRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity OnlineFormDataExRelation to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted OnlineFormDataExRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormDataExRelations/batch-modify: post: description: Create or update an batch of OnlineFormDataExRelations operationId: OnlineFormDataExRelations.batch_create_or_update summary: OnlineFormDataExRelations.batch_create_or_update tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineFormDataExRelations on change. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormDataExRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new OnlineFormDataExRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchOnlineFormDataExRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated OnlineFormDataExRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormDataExRelations/batch-restore: post: description: Restores OnlineFormDataExRelations with given list of ids operationId: OnlineFormDataExRelations.batch_restore summary: OnlineFormDataExRelations.batch_restore tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineFormDataExRelations on restore. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormDataExRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity OnlineFormDataExRelation to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored OnlineFormDataExRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormRelations/{id}: get: description: Returns OnlineFormRelation with given id operationId: OnlineFormRelations.get summary: OnlineFormRelations.get tags: - Online parameters: - name: id in: path description: ID of OnlineFormRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: OnlineFormRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OnlineFormRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes OnlineFormRelation with given id operationId: OnlineFormRelations.delete summary: OnlineFormRelations.delete tags: - Online parameters: - name: id in: path description: ID of OnlineFormRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OnlineFormRelation on delete. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormRelation type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies OnlineFormRelation or OnlineFormRelations with given id(s) parameters: - name: id in: path description: ID of OnlineFormRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OnlineFormRelation on update. Use them as bit mask: 0 - validate each field on entity, 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: OnlineFormRelations.update summary: OnlineFormRelations.update tags: - Online requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateOnlineFormRelationInput' responses: '200': description: Modification confirmation. Returns resulting OnlineFormRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OnlineFormRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormRelations: get: description: Returns all defined OnlineFormRelations operationId: OnlineFormRelations.list summary: OnlineFormRelations.list tags: - Online parameters: - name: include-deleted in: query description: if enabled, deleted OnlineFormRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OnlineFormRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/OnlineFormRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new OnlineFormRelation operationId: OnlineFormRelations.create summary: OnlineFormRelations.create tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineFormRelation on create. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormRelation required: true content: application / json: schema: $ref: '#/components/schemas/createOnlineFormRelationInput' responses: '201': description: Creation confirmation. Returns created OnlineFormRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OnlineFormRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormRelations/batch-delete: post: description: Removes OnlineFormRelations with given list of ids operationId: OnlineFormRelations.batch_delete summary: OnlineFormRelations.batch_delete tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineFormRelations on delete. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity OnlineFormRelation to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted OnlineFormRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormRelations/batch-modify: post: description: Create or update an batch of OnlineFormRelations operationId: OnlineFormRelations.batch_create_or_update summary: OnlineFormRelations.batch_create_or_update tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineFormRelations on change. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new OnlineFormRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchOnlineFormRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated OnlineFormRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormRelations/batch-restore: post: description: Restores OnlineFormRelations with given list of ids operationId: OnlineFormRelations.batch_restore summary: OnlineFormRelations.batch_restore tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineFormRelations on restore. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity OnlineFormRelation to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored OnlineFormRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormStyles/{id}: get: description: Returns OnlineFormStyle with given id operationId: OnlineFormStyles.get summary: OnlineFormStyles.get tags: - Online parameters: - name: id in: path description: ID of OnlineFormStyle to retrieve required: true schema: type: string format: uuid responses: '200': description: OnlineFormStyle data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OnlineFormStyle' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes OnlineFormStyle with given id operationId: OnlineFormStyles.delete summary: OnlineFormStyles.delete tags: - Online parameters: - name: id in: path description: ID of OnlineFormStyle to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OnlineFormStyle on delete. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormStyle type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies OnlineFormStyle or OnlineFormStyles with given id(s) parameters: - name: id in: path description: ID of OnlineFormStyle to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OnlineFormStyle on update. Use them as bit mask: 0 - validate each field on entity, 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: OnlineFormStyles.update summary: OnlineFormStyles.update tags: - Online requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateOnlineFormStyleInput' responses: '200': description: Modification confirmation. Returns resulting OnlineFormStyle content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OnlineFormStyle' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormStyles: get: description: Returns all defined OnlineFormStyles operationId: OnlineFormStyles.list summary: OnlineFormStyles.list tags: - Online parameters: - name: include-deleted in: query description: if enabled, deleted OnlineFormStyles are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OnlineFormStyles content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/OnlineFormStyle' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new OnlineFormStyle operationId: OnlineFormStyles.create summary: OnlineFormStyles.create tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineFormStyle on create. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormStyle required: true content: application / json: schema: $ref: '#/components/schemas/createOnlineFormStyleInput' responses: '201': description: Creation confirmation. Returns created OnlineFormStyle content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OnlineFormStyle' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormStyles/batch-delete: post: description: Removes OnlineFormStyles with given list of ids operationId: OnlineFormStyles.batch_delete summary: OnlineFormStyles.batch_delete tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineFormStyles on delete. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormStyles. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity OnlineFormStyle to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted OnlineFormStyle. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormStyles/batch-modify: post: description: Create or update an batch of OnlineFormStyles operationId: OnlineFormStyles.batch_create_or_update summary: OnlineFormStyles.batch_create_or_update tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineFormStyles on change. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormStyles. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new OnlineFormStyle required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchOnlineFormStyleInput' responses: '200': description: Creation confirmation. Returns a list of created / updated OnlineFormStyles content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormStyles/batch-restore: post: description: Restores OnlineFormStyles with given list of ids operationId: OnlineFormStyles.batch_restore summary: OnlineFormStyles.batch_restore tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineFormStyles on restore. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormStyles. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity OnlineFormStyle to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored OnlineFormStyle. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormTypes/{id}: get: description: Returns OnlineFormType with given id operationId: OnlineFormTypes.get summary: OnlineFormTypes.get tags: - Online parameters: - name: id in: path description: ID of OnlineFormType to retrieve required: true schema: type: string format: uuid responses: '200': description: OnlineFormType data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OnlineFormType' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes OnlineFormType with given id operationId: OnlineFormTypes.delete summary: OnlineFormTypes.delete tags: - Online parameters: - name: id in: path description: ID of OnlineFormType to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OnlineFormType on delete. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormType type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies OnlineFormType or OnlineFormTypes with given id(s) parameters: - name: id in: path description: ID of OnlineFormType to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OnlineFormType on update. Use them as bit mask: 0 - validate each field on entity, 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: OnlineFormTypes.update summary: OnlineFormTypes.update tags: - Online requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateOnlineFormTypeInput' responses: '200': description: Modification confirmation. Returns resulting OnlineFormType content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OnlineFormType' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormTypes: get: description: Returns all defined OnlineFormTypes operationId: OnlineFormTypes.list summary: OnlineFormTypes.list tags: - Online parameters: - name: include-deleted in: query description: if enabled, deleted OnlineFormTypes are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OnlineFormTypes content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/OnlineFormType' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new OnlineFormType operationId: OnlineFormTypes.create summary: OnlineFormTypes.create tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineFormType on create. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormType required: true content: application / json: schema: $ref: '#/components/schemas/createOnlineFormTypeInput' responses: '201': description: Creation confirmation. Returns created OnlineFormType content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OnlineFormType' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormTypes/batch-delete: post: description: Removes OnlineFormTypes with given list of ids operationId: OnlineFormTypes.batch_delete summary: OnlineFormTypes.batch_delete tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineFormTypes on delete. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity OnlineFormType to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted OnlineFormType. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormTypes/batch-modify: post: description: Create or update an batch of OnlineFormTypes operationId: OnlineFormTypes.batch_create_or_update summary: OnlineFormTypes.batch_create_or_update tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineFormTypes on change. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new OnlineFormType required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchOnlineFormTypeInput' responses: '200': description: Creation confirmation. Returns a list of created / updated OnlineFormTypes content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormTypes/batch-restore: post: description: Restores OnlineFormTypes with given list of ids operationId: OnlineFormTypes.batch_restore summary: OnlineFormTypes.batch_restore tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineFormTypes on restore. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity OnlineFormType to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored OnlineFormType. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormTypeEmailRelations/{id}: get: description: Returns OnlineFormTypeEmailRelation with given id operationId: OnlineFormTypeEmailRelations.get summary: OnlineFormTypeEmailRelations.get tags: - Online parameters: - name: id in: path description: ID of OnlineFormTypeEmailRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: OnlineFormTypeEmailRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OnlineFormTypeEmailRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes OnlineFormTypeEmailRelation with given id operationId: OnlineFormTypeEmailRelations.delete summary: OnlineFormTypeEmailRelations.delete tags: - Online parameters: - name: id in: path description: ID of OnlineFormTypeEmailRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OnlineFormTypeEmailRelation on delete. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormTypeEmailRelation type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies OnlineFormTypeEmailRelation or OnlineFormTypeEmailRelations with given id(s) parameters: - name: id in: path description: ID of OnlineFormTypeEmailRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of OnlineFormTypeEmailRelation on update. Use them as bit mask: 0 - validate each field on entity, 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: OnlineFormTypeEmailRelations.update summary: OnlineFormTypeEmailRelations.update tags: - Online requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateOnlineFormTypeEmailRelationInput' responses: '200': description: Modification confirmation. Returns resulting OnlineFormTypeEmailRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OnlineFormTypeEmailRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormTypeEmailRelations: get: description: Returns all defined OnlineFormTypeEmailRelations operationId: OnlineFormTypeEmailRelations.list summary: OnlineFormTypeEmailRelations.list tags: - Online parameters: - name: include-deleted in: query description: if enabled, deleted OnlineFormTypeEmailRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of OnlineFormTypeEmailRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/OnlineFormTypeEmailRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new OnlineFormTypeEmailRelation operationId: OnlineFormTypeEmailRelations.create summary: OnlineFormTypeEmailRelations.create tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineFormTypeEmailRelation on create. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormTypeEmailRelation required: true content: application / json: schema: $ref: '#/components/schemas/createOnlineFormTypeEmailRelationInput' responses: '201': description: Creation confirmation. Returns created OnlineFormTypeEmailRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/OnlineFormTypeEmailRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormTypeEmailRelations/batch-delete: post: description: Removes OnlineFormTypeEmailRelations with given list of ids operationId: OnlineFormTypeEmailRelations.batch_delete summary: OnlineFormTypeEmailRelations.batch_delete tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineFormTypeEmailRelations on delete. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormTypeEmailRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity OnlineFormTypeEmailRelation to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted OnlineFormTypeEmailRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormTypeEmailRelations/batch-modify: post: description: Create or update an batch of OnlineFormTypeEmailRelations operationId: OnlineFormTypeEmailRelations.batch_create_or_update summary: OnlineFormTypeEmailRelations.batch_create_or_update tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineFormTypeEmailRelations on change. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormTypeEmailRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new OnlineFormTypeEmailRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchOnlineFormTypeEmailRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated OnlineFormTypeEmailRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/OnlineFormTypeEmailRelations/batch-restore: post: description: Restores OnlineFormTypeEmailRelations with given list of ids operationId: OnlineFormTypeEmailRelations.batch_restore summary: OnlineFormTypeEmailRelations.batch_restore tags: - Online parameters: - name: validation-level in: query description: 'Specify validation level of OnlineFormTypeEmailRelations on restore. Use them as bit mask: 0 - validate each field on entity, 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 OnlineFormTypeEmailRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity OnlineFormTypeEmailRelation to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored OnlineFormTypeEmailRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: createOnlineFormTypeEmailRelationInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked account. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked contact. custom_entity_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked custom entity record. email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email message. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked lead or opportunity, or empty when not linked. online_form_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the online form. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked quote. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - email_id - online_form_type_id updateOnlineFormActivityLogLineInput: properties: executed_at: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run. is_visible: type: boolean example: false description: True when the line is shown in the activity log UI; false for internal-only lines. online_form_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the submission. sort_order: type: integer format: int32 example: 1 description: Position of the line within its log run. status: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired' example: 1 enum: - 1 - 2 - 3 - 4 - 5 OnlineFormActivityLogLine: properties: formatted_text: type: string example: string description: Human-readable rendering of the log line, prefixed with the line's timestamp and (when applicable) the parent record id. is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true online_form: type: string format: uri description: 'Online form submission this log line belongs to. Relation to OnlineForm. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''OnlineForm'' object for properties.' executed_at: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run. is_visible: type: boolean example: false description: True when the line is shown in the activity log UI; false for internal-only lines. online_form_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the submission. sort_order: type: integer format: int32 example: 1 description: Position of the line within its log run. status: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired' example: 1 enum: - 1 - 2 - 3 - 4 - 5 required: - formatted_text - is_delete_protected - id - online_form - online_form_id - sort_order updateOnlineFormStyleInput: properties: name: type: string example: string description: Name of the entity and its default text representation. settings: type: object description: JSON definition of the style applied to the form (colors, fonts, layout). When null, the default style is used. use_lang: type: boolean example: false description: When true, the style name is treated as a translation key and localized in the UI; otherwise the literal name is shown. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. 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 batchOnlineFormRelationInput: properties: account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked account. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked contact. custom_entity_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked custom entity record. is_primary: type: boolean example: false description: True for the row that points to the submission's primary record. There is at most one primary relation per submission and its entity must match the form's entity_type. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked lead or opportunity, or empty when not linked. online_form_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the submission. project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked project. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked quote. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid createOnlineFormInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true currency_exchange_rates_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the exchange rate list. email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked email record, when available. field_ids: type: object description: Ids of the fields included in the form when this submission was captured, as a JSON array of field ids (UUIDs). online_form_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the online form definition. product_currency_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the selected currency. product_price_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the selected price list. status: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired' example: 1 enum: - 1 - 2 - 3 - 4 - 5 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. account_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OnlineFormRelation, see: ''createOnlineFormRelationInput'' object for properties.' description: Accounts the submission was linked to. contact_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OnlineFormRelation, see: ''createOnlineFormRelationInput'' object for properties.' description: Contacts the submission was linked to. lead_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OnlineFormRelation, see: ''createOnlineFormRelationInput'' object for properties.' description: Leads the submission was linked to. opportunity_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OnlineFormRelation, see: ''createOnlineFormRelationInput'' object for properties.' description: Opportunities the submission was linked to. quote_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OnlineFormRelation, see: ''createOnlineFormRelationInput'' object for properties.' description: Quotes the submission was linked to. project_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OnlineFormRelation, see: ''createOnlineFormRelationInput'' object for properties.' description: Projects the submission was linked to. custom_entity_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OnlineFormRelation, see: ''createOnlineFormRelationInput'' object for properties.' description: Custom entity records the submission was linked to. required: - field_ids - online_form_type_id updateOnlineFormInput: properties: currency_exchange_rates_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the exchange rate list. email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked email record, when available. field_ids: type: object description: Ids of the fields included in the form when this submission was captured, as a JSON array of field ids (UUIDs). online_form_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the online form definition. product_currency_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the selected currency. product_price_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the selected price list. status: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired' example: 1 enum: - 1 - 2 - 3 - 4 - 5 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. account_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OnlineFormRelation, see: ''updateOnlineFormRelationInput'' object for properties.' description: Accounts the submission was linked to. contact_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OnlineFormRelation, see: ''updateOnlineFormRelationInput'' object for properties.' description: Contacts the submission was linked to. lead_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OnlineFormRelation, see: ''updateOnlineFormRelationInput'' object for properties.' description: Leads the submission was linked to. opportunity_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OnlineFormRelation, see: ''updateOnlineFormRelationInput'' object for properties.' description: Opportunities the submission was linked to. quote_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OnlineFormRelation, see: ''updateOnlineFormRelationInput'' object for properties.' description: Quotes the submission was linked to. project_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OnlineFormRelation, see: ''updateOnlineFormRelationInput'' object for properties.' description: Projects the submission was linked to. custom_entity_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OnlineFormRelation, see: ''updateOnlineFormRelationInput'' object for properties.' description: Custom entity records the submission was linked to. updateOnlineFormTypeInput: properties: auto_prefill_with_javascript: type: boolean example: false description: When true, the embedded form JavaScript pre-fills fields from URL query parameters on load. description: type: string example: string description: Free-text description shown alongside the form definition in the UI. entity_api_name: type: string example: string description: API name of the custom entity the form targets. Set only when entity_type is CustomEntity; otherwise empty. entity_type: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product' example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 form_edit: type: object description: Definition of the form layout (fields, sections, settings) shown to respondents, as a JSON object conforming to the online-form layout schema. Validated on write. is_enabled: type: boolean example: false description: When true, the form is published and accepts new submissions; when false, the form returns an error to respondents. is_readonly: type: boolean example: false description: True when the form is system-managed and its schema cannot be edited by users. last_schema_change: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of the most recent change to form_edit (form schema). last_status_change: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of the most recent change to is_enabled. name: type: string example: string description: Name of the entity and its default text representation. notifications_status: type: object description: Tracks which threshold-reached notifications have already been sent for the current form configuration. Reset when the configuration changes. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the owning user. style_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the form style. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. custom_recaptcha: type: string format: binary example: blob description: '' OnlineFormDataExRelation: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true data: type: string format: uri description: 'Data record holding the additional fields linked to the online form submission. Relation to Data. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Data'' object for properties.' online_form: type: string format: uri description: 'Online form this data relation row belongs to. Relation to OnlineForm. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''OnlineForm'' object for properties.' data_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the data record. data_set_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the data set the linked fields belong to. online_form_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the online form. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - data - online_form - data_id - data_set_id - online_form_id updateOnlineFormDataExRelationInput: properties: data_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the data record. data_set_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the data set the linked fields belong to. online_form_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the online form. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. batchOnlineFormStyleInput: properties: name: type: string example: string description: Name of the entity and its default text representation. settings: type: object description: JSON definition of the style applied to the form (colors, fonts, layout). When null, the default style is used. use_lang: type: boolean example: false description: When true, the style name is treated as a translation key and localized in the UI; otherwise the literal name is shown. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid updateOnlineFormTypeEmailRelationInput: properties: account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked account. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked contact. custom_entity_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked custom entity record. email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email message. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked lead or opportunity, or empty when not linked. online_form_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the online form. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked quote. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. createOnlineFormDataExRelationInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true data_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the data record. data_set_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the data set the linked fields belong to. online_form_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the online form. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - data_id - data_set_id - online_form_id batchOnlineFormTypeInput: properties: auto_prefill_with_javascript: type: boolean example: false description: When true, the embedded form JavaScript pre-fills fields from URL query parameters on load. description: type: string example: string description: Free-text description shown alongside the form definition in the UI. entity_api_name: type: string example: string description: API name of the custom entity the form targets. Set only when entity_type is CustomEntity; otherwise empty. entity_type: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product' example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 form_edit: type: object description: Definition of the form layout (fields, sections, settings) shown to respondents, as a JSON object conforming to the online-form layout schema. Validated on write. is_enabled: type: boolean example: false description: When true, the form is published and accepts new submissions; when false, the form returns an error to respondents. is_readonly: type: boolean example: false description: True when the form is system-managed and its schema cannot be edited by users. last_schema_change: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of the most recent change to form_edit (form schema). last_status_change: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of the most recent change to is_enabled. name: type: string example: string description: Name of the entity and its default text representation. notifications_status: type: object description: Tracks which threshold-reached notifications have already been sent for the current form configuration. Reset when the configuration changes. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the owning user. style_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the form style. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. custom_recaptcha: type: string format: binary example: blob description: '' id: description: ID of object to update. type: string format: uuid createOnlineFormTypeInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true auto_prefill_with_javascript: type: boolean example: false description: When true, the embedded form JavaScript pre-fills fields from URL query parameters on load. description: type: string example: string description: Free-text description shown alongside the form definition in the UI. entity_api_name: type: string example: string description: API name of the custom entity the form targets. Set only when entity_type is CustomEntity; otherwise empty. entity_type: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product' example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 form_edit: type: object description: Definition of the form layout (fields, sections, settings) shown to respondents, as a JSON object conforming to the online-form layout schema. Validated on write. is_enabled: type: boolean example: false description: When true, the form is published and accepts new submissions; when false, the form returns an error to respondents. is_readonly: type: boolean example: false description: True when the form is system-managed and its schema cannot be edited by users. last_schema_change: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of the most recent change to form_edit (form schema). last_status_change: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of the most recent change to is_enabled. name: type: string example: string description: Name of the entity and its default text representation. notifications_status: type: object description: Tracks which threshold-reached notifications have already been sent for the current form configuration. Reset when the configuration changes. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the owning user. style_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the form style. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. custom_recaptcha: type: string format: binary example: blob description: '' required: - entity_type - form_edit - is_enabled - is_readonly - name - owner_id - style_id - custom_recaptcha OnlineFormTypeEmailRelation: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true account: type: string format: uri description: 'Account the email recipient belongs to, when applicable. 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.' contact: type: string format: uri description: 'Contact the email was addressed to, when applicable. Relation to Contact. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Contact'' object for properties.' custom_entity: type: string format: uri description: 'Custom entity record the form was sent on, when applicable. Relation to CustomEntity. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''CustomEntity'' object for properties.' email: type: string format: uri description: 'Email message used to deliver the form link to the recipient. 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.' lead: type: string format: uri description: 'Lead the form was sent on. Set when lead_oppty_id resolves to a Lead. Relation to Lead. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Lead'' object for properties.' oppty: type: string format: uri description: 'Opportunity the form was sent on. Set when lead_oppty_id resolves to an Opportunity. Relation to Opportunity. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Opportunity'' object for properties.' online_form_type: type: string format: uri description: 'Online form being shared with the recipient via email. Relation to OnlineFormType. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''OnlineFormType'' object for properties.' quote: type: string format: uri description: 'Quote the form was sent on, when applicable. Relation to Quote. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Quote'' object for properties.' account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked account. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked contact. custom_entity_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked custom entity record. email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email message. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked lead or opportunity, or empty when not linked. online_form_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the online form. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked quote. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - email - online_form_type - email_id - online_form_type_id batchOnlineFormActivityLogLineInput: properties: executed_at: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run. is_visible: type: boolean example: false description: True when the line is shown in the activity log UI; false for internal-only lines. online_form_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the submission. sort_order: type: integer format: int32 example: 1 description: Position of the line within its log run. status: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired' example: 1 enum: - 1 - 2 - 3 - 4 - 5 id: description: ID of object to update. type: string format: uuid updateOnlineFormRelationInput: properties: account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked account. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked contact. custom_entity_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked custom entity record. is_primary: type: boolean example: false description: True for the row that points to the submission's primary record. There is at most one primary relation per submission and its entity must match the form's entity_type. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked lead or opportunity, or empty when not linked. online_form_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the submission. project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked project. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked quote. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. OnlineForm: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true currency_exchange_rates_list: type: string format: uri description: 'Currency exchange rate list applied to product line-items at submission time. Relation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''CurrencyExchangeRatesList'' object for properties.' email: type: string format: uri description: 'Email submitted with the response, used for identification or response notifications. 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.' online_form_type: type: string format: uri description: 'Online form definition this submission belongs to. Relation to OnlineFormType. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''OnlineFormType'' object for properties.' product_currency: type: string format: uri description: 'Currency selected by the respondent for product line-items, when the form contains products. Relation to Currency. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Currency'' object for properties.' product_price_list: type: string format: uri description: 'Product price list selected by the respondent, when the form contains products. Relation to ProductPriceList. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''ProductPriceList'' object for properties.' currency_exchange_rates_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the exchange rate list. email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked email record, when available. field_ids: type: object description: Ids of the fields included in the form when this submission was captured, as a JSON array of field ids (UUIDs). online_form_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the online form definition. product_currency_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the selected currency. product_price_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the selected price list. status: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired' example: 1 enum: - 1 - 2 - 3 - 4 - 5 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. account_relations: type: array items: type: string format: uri description: 'Relation to OnlineFormRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''OnlineFormRelation'' object for properties.' description: Accounts the submission was linked to. contact_relations: type: array items: type: string format: uri description: 'Relation to OnlineFormRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''OnlineFormRelation'' object for properties.' description: Contacts the submission was linked to. lead_relations: type: array items: type: string format: uri description: 'Relation to OnlineFormRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''OnlineFormRelation'' object for properties.' description: Leads the submission was linked to. opportunity_relations: type: array items: type: string format: uri description: 'Relation to OnlineFormRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''OnlineFormRelation'' object for properties.' description: Opportunities the submission was linked to. quote_relations: type: array items: type: string format: uri description: 'Relation to OnlineFormRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''OnlineFormRelation'' object for properties.' description: Quotes the submission was linked to. project_relations: type: array items: type: string format: uri description: 'Relation to OnlineFormRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''OnlineFormRelation'' object for properties.' description: Projects the submission was linked to. custom_entity_relations: type: array items: type: string format: uri description: 'Relation to OnlineFormRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''OnlineFormRelation'' object for properties.' description: Custom entity records the submission was linked to. lines: type: array items: type: string format: uri description: 'Relation to OnlineFormActivityLogLine. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''OnlineFormActivityLogLine'' object for properties.' description: Activity log lines describing what was done with this submission (visible only). responded_by: type: string example: string description: Display name of the primary record (account/contact/lead/...) the submission was linked to. response_date: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp the submission was received (the response was completed). required: - is_delete_protected - id - online_form_type - product_currency - field_ids - online_form_type_id - responded_by createOnlineFormRelationInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked account. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked contact. custom_entity_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked custom entity record. is_primary: type: boolean example: false description: True for the row that points to the submission's primary record. There is at most one primary relation per submission and its entity must match the form's entity_type. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked lead or opportunity, or empty when not linked. online_form_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the submission. project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked project. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked quote. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_primary - online_form_id createOnlineFormStyleInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true name: type: string example: string description: Name of the entity and its default text representation. settings: type: object description: JSON definition of the style applied to the form (colors, fonts, layout). When null, the default style is used. use_lang: type: boolean example: false description: When true, the style name is treated as a translation key and localized in the UI; otherwise the literal name is shown. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - name createOnlineFormActivityLogLineInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true executed_at: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run. is_visible: type: boolean example: false description: True when the line is shown in the activity log UI; false for internal-only lines. online_form_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the submission. sort_order: type: integer format: int32 example: 1 description: Position of the line within its log run. status: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired' example: 1 enum: - 1 - 2 - 3 - 4 - 5 required: - online_form_id - sort_order OnlineFormRelation: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true account: type: string format: uri description: 'Account the submission is linked to, when applicable. 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.' contact: type: string format: uri description: 'Contact the submission is linked to, when applicable. Relation to Contact. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Contact'' object for properties.' custom_entity: type: string format: uri description: 'Custom entity record the submission is linked to, when applicable. Relation to CustomEntity. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''CustomEntity'' object for properties.' lead: type: string format: uri description: 'Lead the submission is linked to. Set when lead_oppty_id resolves to a Lead. Relation to Lead. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Lead'' object for properties.' oppty: type: string format: uri description: 'Opportunity the submission is linked to. Set when lead_oppty_id resolves to an Opportunity. Relation to Opportunity. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Opportunity'' object for properties.' online_form: type: string format: uri description: 'Online form submission being linked. Relation to OnlineForm. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''OnlineForm'' object for properties.' project: type: string format: uri description: 'Project the submission is linked to, when applicable. Relation to Project. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Project'' object for properties.' quote: type: string format: uri description: 'Quote the submission is linked to, when applicable. Relation to Quote. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Quote'' object for properties.' account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked account. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked contact. custom_entity_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked custom entity record. is_primary: type: boolean example: false description: True for the row that points to the submission's primary record. There is at most one primary relation per submission and its entity must match the form's entity_type. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked lead or opportunity, or empty when not linked. online_form_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the submission. project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked project. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked quote. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - is_primary - online_form_id OnlineFormType: properties: has_draft: type: boolean example: false description: Set to True if draft for entity exists and can be published is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true form_edit_api: type: object description: API-friendly view of the form definition merged with any pending draft changes. Read-only; modify form_edit through drafts. can_change_readonly: type: boolean example: false description: Returns if user can change readonly flag on this entity_type. id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true owner: type: string format: uri description: 'User who owns the online form. 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.' style: type: string format: uri description: 'Visual style applied to the form when rendered. Relation to OnlineFormStyle. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''OnlineFormStyle'' object for properties.' auto_prefill_with_javascript: type: boolean example: false description: When true, the embedded form JavaScript pre-fills fields from URL query parameters on load. description: type: string example: string description: Free-text description shown alongside the form definition in the UI. entity_api_name: type: string example: string description: API name of the custom entity the form targets. Set only when entity_type is CustomEntity; otherwise empty. entity_type: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product' example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 form_edit: type: object description: Definition of the form layout (fields, sections, settings) shown to respondents, as a JSON object conforming to the online-form layout schema. Validated on write. is_enabled: type: boolean example: false description: When true, the form is published and accepts new submissions; when false, the form returns an error to respondents. is_readonly: type: boolean example: false description: True when the form is system-managed and its schema cannot be edited by users. last_schema_change: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of the most recent change to form_edit (form schema). last_status_change: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of the most recent change to is_enabled. name: type: string example: string description: Name of the entity and its default text representation. notifications_status: type: object description: Tracks which threshold-reached notifications have already been sent for the current form configuration. Reset when the configuration changes. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the owning user. style_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the form style. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. activity_logs: type: array items: type: string format: uri description: 'Relation to OnlineForm. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''OnlineForm'' object for properties.' description: Submissions (one per response) recorded for this form. link_id: type: string example: string description: Short identifier used in the public form URL (see link). Stable across the lifetime of the form. summarized_response_values: type: integer format: int32 example: 1 description: Sum of response values used to evaluate the response acceptance threshold (e.g. total responses, or evaluated value of the custom acceptance condition). Empty when no threshold is configured. link: type: string example: string description: Public URL for accessing the form (suitable for sharing with respondents). has_custom_recaptcha: type: boolean example: false description: True when the form is configured with custom reCAPTCHA credentials; false when using the platform default reCAPTCHA setup. required: - has_draft - is_delete_protected - form_edit_api - id - owner - style - entity_type - form_edit - is_enabled - is_readonly - name - owner_id - style_id - link_id - has_custom_recaptcha batchOnlineFormInput: properties: currency_exchange_rates_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the exchange rate list. email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked email record, when available. field_ids: type: object description: Ids of the fields included in the form when this submission was captured, as a JSON array of field ids (UUIDs). online_form_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the online form definition. product_currency_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the selected currency. product_price_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the selected price list. status: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired' example: 1 enum: - 1 - 2 - 3 - 4 - 5 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. account_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OnlineFormRelation, see: ''updateOnlineFormRelationInput'' object for properties.' description: Accounts the submission was linked to. contact_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OnlineFormRelation, see: ''updateOnlineFormRelationInput'' object for properties.' description: Contacts the submission was linked to. lead_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OnlineFormRelation, see: ''updateOnlineFormRelationInput'' object for properties.' description: Leads the submission was linked to. opportunity_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OnlineFormRelation, see: ''updateOnlineFormRelationInput'' object for properties.' description: Opportunities the submission was linked to. quote_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OnlineFormRelation, see: ''updateOnlineFormRelationInput'' object for properties.' description: Quotes the submission was linked to. project_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OnlineFormRelation, see: ''updateOnlineFormRelationInput'' object for properties.' description: Projects the submission was linked to. custom_entity_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OnlineFormRelation, see: ''updateOnlineFormRelationInput'' object for properties.' description: Custom entity records the submission was linked to. id: description: ID of object to update. type: string format: uuid OnlineFormStyle: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true name: type: string example: string description: Name of the entity and its default text representation. settings: type: object description: JSON definition of the style applied to the form (colors, fonts, layout). When null, the default style is used. use_lang: type: boolean example: false description: When true, the style name is treated as a translation key and localized in the UI; otherwise the literal name is shown. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - name batchOnlineFormDataExRelationInput: properties: data_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the data record. data_set_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the data set the linked fields belong to. online_form_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the online form. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid batchOnlineFormTypeEmailRelationInput: properties: account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked account. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked contact. custom_entity_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked custom entity record. email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the email message. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked lead or opportunity, or empty when not linked. online_form_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the online form. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked quote. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid